Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

## Logical Model: USRealmHeader - Detailed Descriptions

Draft as of 2023-09-29

Definitions for the USRealmHeader logical model.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

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

0. ClinicalDocument
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. ClinicalDocument.realmCode
Comments | SHALL contain exactly one [1..1] realmCode="US" (CONF:4537-16791).
Control | 1..1
4. ClinicalDocument.realmCode.code
Control | 1..?
Pattern Value | US
6. ClinicalDocument.typeId
Comments | SHALL contain exactly one [1..1] typeId (CONF:4537-5361).
8. ClinicalDocument.typeId.root
Comments | This typeId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.1.3" (CONF:4537-5250).
10. ClinicalDocument.typeId.extension
Comments | This typeId SHALL contain exactly one [1..1] @extension="POCD_HD000040" (CONF:4537-5251).
Fixed Value | POCD_HD000040
12. ClinicalDocument.templateId
Control | 1..?
Slicing | This element introduces a set of slices on `ClinicalDocument.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ root value @ extension
14. ClinicalDocument.templateId:us-realm
Slice Name | us-realm
Short | templateId
Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-5252) such that it
Control | 1..1
16. ClinicalDocument.templateId:us-realm.root
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.1" (CONF:4537-10036).
Control | 1..?
Pattern Value | 2.16.840.1.113883.10.20.22.1.1
18. ClinicalDocument.templateId:us-realm.extension
Comments | SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-32503).
Control | 1..?
Pattern Value | 2023-05-01
20. ClinicalDocument.id
Comments | SHALL contain exactly one [1..1] id (CONF:4537-5363).
Invariants | 4537-9991: This id **SHALL** be a globally unique identifier for the document (CONF:4537-9991). ()
22. ClinicalDocument.code
Comments | SHALL contain exactly one [1..1] code (CONF:4537-5253).
Invariants | 4537-9992: This code **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992). () 4537-32948: This code **SHALL** be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:4537-32948). ()
24. ClinicalDocument.title
Short | The 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).
Control | 1..?
26. ClinicalDocument.effectiveTime
Comments | SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5256).
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
28. 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).
Binding | The codes SHOULD be taken from HL7 BasicConfidentialityKind
30. ClinicalDocument.languageCode
Comments | SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:4537-5372).
Control | 1..?
Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526
32. ClinicalDocument.setId
Comments | MAY contain zero or one [0..1] setId (CONF:4537-5261).
Invariants | 4537-6380: If setId is present versionNumber **SHALL** be present (CONF:4537-6380). ()
34. ClinicalDocument.versionNumber
Comments | MAY contain zero or one [0..1] versionNumber (CONF:4537-5264).
Invariants | 4537-6387: If versionNumber is present setId **SHALL** be present (CONF:4537-6387). ()
36. ClinicalDocument.recordTarget
Comments | SHALL contain at least one [1..*] recordTarget (CONF:4537-5266).
38. ClinicalDocument.recordTarget.patientRole
Comments | Such recordTargets SHALL contain exactly one [1..1] patientRole (CONF:4537-5267).
40. ClinicalDocument.recordTarget.patientRole.id
Comments | This patientRole SHALL contain at least one [1..*] id (CONF:4537-5268).
42. ClinicalDocument.recordTarget.patientRole.addr
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).
Control | 1..?
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
44. ClinicalDocument.recordTarget.patientRole.telecom
Comments | This patientRole SHALL contain at least one [1..*] telecom (CONF:4537-5280).
Control | 1..?
46. ClinicalDocument.recordTarget.patientRole.telecom.use
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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
48. ClinicalDocument.recordTarget.patientRole.patient
Comments | This patientRole SHALL contain exactly one [1..1] patient (CONF:4537-5283).
Control | 1..?
50. ClinicalDocument.recordTarget.patientRole.patient.name
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).
Control | 1..?
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Patient Name (PTN.US.FIELDED))
52. 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).
Control | 1..?
Binding | The codes SHALL be taken from Administrative Gender (HL7 V3)
54. ClinicalDocument.recordTarget.patientRole.patient.birthTime
Comments | This patient SHALL contain exactly one [1..1] birthTime (CONF:4537-5298).
Control | 1..?
Invariants | 4537-5299: **SHALL** be precise to year (CONF:4537-5299). () 4537-5300: **SHOULD** be precise to day (CONF:4537-5300). () 4537-32418: **MAY** be precise to the minute (CONF:4537-32418). ()
56. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd
Short | sdtc:deceasedInd
Comments | This patient MAY contain zero or one [0..1] sdtc:deceasedInd (CONF:4537-32990).
Invariants | 4537-32993: If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present (CONF:4537-32993). ()
58. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime
Short | sdtc:deceasedTime
Comments | This patient MAY contain zero or one [0..1] sdtc:deceasedTime (CONF:4537-32988).
60. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime.value
Comments | The sdtc:deceasedTime, if present, SHOULD contain zero or one [0..1] @value (CONF:4537-32989).
Invariants | 4537-32991: **SHALL** be precise to to the year (CONF:4537-32991). () 4537-32992: **SHOULD** be precise to the day (CONF:4537-32992). ()
62. 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).
Binding | The codes SHALL be taken from Marital Status
64. 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).
Binding | The codes SHALL be taken from Religious Affiliation
66. ClinicalDocument.recordTarget.patientRole.patient.raceCode
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).
Control | 1..?
Binding | The codes SHALL be taken from Race Category Excluding Nulls
68. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode
Short | 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).
Binding | The codes SHALL be taken from Race Value Set
Invariants | 4537-31347: If sdtc:raceCode is present, then the patient **SHALL** contain [1..1] raceCode (CONF:4537-31347). ()
70. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode
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).
Control | 1..?
Binding | The codes SHALL be taken from Ethnicity
72. ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode
Short | ethnicGroupCode
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).
Binding | The codes SHALL be taken from Detailed Ethnicity
74. ClinicalDocument.recordTarget.patientRole.patient.guardian
Comments | This patient MAY contain zero or more [0..*] guardian (CONF:4537-5325).
76. 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).
Binding | The codes SHALL be taken from Personal And Legal Relationship Role Type
78. ClinicalDocument.recordTarget.patientRole.patient.guardian.addr
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).
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
80. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom
Comments | The guardian, if present, SHOULD contain zero or more [0..*] telecom (CONF:4537-5382).
82. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.use
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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
84. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson
Comments | The guardian, if present, SHALL contain exactly one [1..1] guardianPerson (CONF:4537-5385).
Control | 1..?
86. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name
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).
Control | 1..?
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
88. ClinicalDocument.recordTarget.patientRole.patient.birthplace
Comments | This patient MAY contain zero or one [0..1] birthplace (CONF:4537-5395).
90. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place
Comments | The birthplace, if present, SHALL contain exactly one [1..1] place (CONF:4537-5396).
92. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr
Comments | This place SHALL contain exactly one [1..1] addr (CONF:4537-5397).
Control | 1..?
Invariants | 4537-5402: If country is US, this addr **SHALL** contain exactly one [1..1] state, which **SHALL** be selected from ValueSet StateValueSet 2.16.840.1.113883.3.88.12.80.1 *DYNAMIC* (CONF:4537-5402). () 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). ()
94. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country
Comments | This addr SHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:4537-5404).
Control | 0..1
Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.3.88.12.80.63
96. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication
Comments | This patient SHOULD contain zero or more [0..*] languageCommunication (CONF:4537-5406).
98. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode
Comments | The languageCommunication, if present, SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:4537-5407).
Control | 1..?
Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526
100. 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).
Binding | The codes SHALL be taken from LanguageAbilityMode
102. 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).
Binding | The codes SHALL be taken from LanguageAbilityProficiency
104. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd
Comments | The languageCommunication, if present, SHOULD contain zero or one [0..1] preferenceInd (CONF:4537-5414).
106. ClinicalDocument.recordTarget.patientRole.providerOrganization
Comments | This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:4537-5416).
108. ClinicalDocument.recordTarget.patientRole.providerOrganization.id
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] id (CONF:4537-5417).
Control | 1..?
110. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.root
Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16820).
Pattern Value | 2.16.840.1.113883.4.6
112. ClinicalDocument.recordTarget.patientRole.providerOrganization.name
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] name (CONF:4537-5419).
Control | 1..?
114. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] telecom (CONF:4537-5420).
Control | 1..?
116. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.use
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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
118. ClinicalDocument.recordTarget.patientRole.providerOrganization.addr
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).
Control | 1..?
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
120. ClinicalDocument.author
Comments | SHALL contain at least one [1..*] author (CONF:4537-5444).
122. ClinicalDocument.author.time
Comments | Such authors SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5445).
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
124. ClinicalDocument.author.assignedAuthor
Comments | Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:4537-5448).
Invariants | 4537-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). ()
126. 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).
Slicing | This 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: , and can be differentiated using the following discriminators: value @ root
128. ClinicalDocument.author.assignedAuthor.id:id1
Slice Name | id1
Short | id
Comments | This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:4537-32882) such that it
Control | 0..1
130. ClinicalDocument.author.assignedAuthor.id:id1.nullFlavor
Comments | MAY contain zero or one [0..1] @nullFlavor="UNK" Unknown (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:4537-32883).
Fixed Value | UNK
132. ClinicalDocument.author.assignedAuthor.id:id1.root
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-32884).
Control | 1..?
Pattern Value | 2.16.840.1.113883.4.6
134. ClinicalDocument.author.assignedAuthor.id:id1.extension
Comments | SHOULD contain zero or one [0..1] @extension (CONF:4537-32885).
136. ClinicalDocument.author.assignedAuthor.code
Comments | This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:4537-16787).
138. ClinicalDocument.author.assignedAuthor.code.code
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).
Control | 1..?
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
140. ClinicalDocument.author.assignedAuthor.addr
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).
Control | 1..?
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
142. ClinicalDocument.author.assignedAuthor.telecom
Comments | This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:4537-5428).
Control | 1..?
144. ClinicalDocument.author.assignedAuthor.telecom.use
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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
146. ClinicalDocument.author.assignedAuthor.assignedPerson
Comments | This assignedAuthor SHOULD contain zero or one [0..1] assignedPerson (CONF:4537-5430).
148. ClinicalDocument.author.assignedAuthor.assignedPerson.name
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).
Control | 1..?
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
150. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice
Comments | This assignedAuthor SHOULD contain zero or one [0..1] assignedAuthoringDevice (CONF:4537-16783).
152. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName
Comments | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] manufacturerModelName (CONF:4537-16784).
Control | 1..?
154. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName
Comments | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] softwareName (CONF:4537-16785).
Control | 1..?
156. ClinicalDocument.dataEnterer
Comments | MAY contain zero or one [0..1] dataEnterer (CONF:4537-5441).
158. ClinicalDocument.dataEnterer.assignedEntity
Comments | The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5442).
160. ClinicalDocument.dataEnterer.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5443).
162. ClinicalDocument.dataEnterer.assignedEntity.id.root
Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16821).
Pattern Value | 2.16.840.1.113883.4.6
164. 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).
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
166. ClinicalDocument.dataEnterer.assignedEntity.addr
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).
Control | 1..?
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
168. ClinicalDocument.dataEnterer.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5466).
Control | 1..?
170. ClinicalDocument.dataEnterer.assignedEntity.telecom.use
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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
172. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5469).
Control | 1..?
174. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name
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).
Control | 1..?
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
176. ClinicalDocument.informant
Comments | MAY contain zero or more [0..*] informant (CONF:4537-31355) such that it
Slicing | This element introduces a set of slices on `ClinicalDocument.informant`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ relatedEntity
178. ClinicalDocument.informant:informant1
Slice Name | informant1
Short | informant
Comments | MAY contain zero or more [0..*] informant (CONF:4537-8001) such that it
Control | 0..*
180. ClinicalDocument.informant:informant1.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8002).
Control | 1..?
182. ClinicalDocument.informant:informant1.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-9945).
Invariants | 4537-9946: If 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). ()
184. ClinicalDocument.informant:informant1.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).
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
186. ClinicalDocument.informant:informant1.assignedEntity.addr
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).
Control | 1..?
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
188. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-8221).
Control | 1..?
190. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name
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).
Control | 1..?
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
192. ClinicalDocument.informant:informant2
Slice Name | informant2
Short | informant
Control | 0..*
194. ClinicalDocument.informant:informant2.relatedEntity
Comments | SHALL contain exactly one [1..1] relatedEntity (CONF:4537-31356).
Control | 1..?
196. ClinicalDocument.custodian
Comments | SHALL contain exactly one [1..1] custodian (CONF:4537-5519).
198. ClinicalDocument.custodian.assignedCustodian
Comments | This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:4537-5520).
200. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
Comments | This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:4537-5521).
202. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
Comments | This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:4537-5522).
204. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.root
Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16822).
Pattern Value | 2.16.840.1.113883.4.6
206. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name
Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:4537-5524).
Control | 1..?
208. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom
Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:4537-5525).
Control | 1..?
210. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.use
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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
212. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr
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).
Control | 1..?
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
214. ClinicalDocument.informationRecipient
Comments | MAY contain zero or more [0..*] informationRecipient (CONF:4537-5565).
216. ClinicalDocument.informationRecipient.intendedRecipient
Comments | The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:4537-5566).
218. ClinicalDocument.informationRecipient.intendedRecipient.id
Comments | This intendedRecipient MAY contain zero or more [0..*] id (CONF:4537-32399).
220. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient
Comments | This intendedRecipient MAY contain zero or one [0..1] informationRecipient (CONF:4537-5567).
222. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name
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).
Control | 1..?
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
224. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization
Comments | This intendedRecipient MAY contain zero or one [0..1] receivedOrganization (CONF:4537-5577).
226. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name
Comments | The receivedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4537-5578).
Control | 1..1
228. ClinicalDocument.legalAuthenticator
Comments | SHOULD contain zero or one [0..1] legalAuthenticator (CONF:4537-5579).
230. ClinicalDocument.legalAuthenticator.time
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5580).
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
232. ClinicalDocument.legalAuthenticator.signatureCode
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:4537-5583).
234. ClinicalDocument.legalAuthenticator.signatureCode.code
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).
Control | 1..?
Pattern Value | S
236. ClinicalDocument.legalAuthenticator.sdtcSignatureText
Short | The 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.
Comments | The legalAuthenticator, if present, MAY contain zero or one [0..1] sdtc:signatureText (CONF:4537-30810).
238. ClinicalDocument.legalAuthenticator.assignedEntity
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5585).
240. ClinicalDocument.legalAuthenticator.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5586).
242. ClinicalDocument.legalAuthenticator.assignedEntity.id.root
Comments | Such ids MAY contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16823).
Pattern Value | 2.16.840.1.113883.4.6
244. 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).
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
246. ClinicalDocument.legalAuthenticator.assignedEntity.addr
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).
Control | 1..?
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
248. ClinicalDocument.legalAuthenticator.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5595).
Control | 1..?
250. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.use
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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
252. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5597).
Control | 1..?
254. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name
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).
Control | 1..?
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
256. ClinicalDocument.authenticator
Comments | MAY contain zero or more [0..*] authenticator (CONF:4537-5607) such that it
Slicing | This element introduces a set of slices on `ClinicalDocument.authenticator`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ ClinicalDocument.signatureCode value @ ClinicalDocument.assignedEntity value @ ClinicalDocument.time
258. ClinicalDocument.authenticator:authenticator1
Slice Name | authenticator1
Short | authenticator
Control | 0..*
260. ClinicalDocument.authenticator:authenticator1.time
Comments | SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5608).
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
262. ClinicalDocument.authenticator:authenticator1.signatureCode
Comments | SHALL contain exactly one [1..1] signatureCode (CONF:4537-5610).
264. ClinicalDocument.authenticator:authenticator1.signatureCode.code
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).
Control | 1..?
Pattern Value | S
266. ClinicalDocument.authenticator:authenticator1.sdtcSignatureText
Short | The 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.
Comments | MAY contain zero or one [0..1] sdtc:signatureText (CONF:4537-30811).
268. ClinicalDocument.authenticator:authenticator1.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5612).
270. ClinicalDocument.authenticator:authenticator1.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5613).
272. ClinicalDocument.authenticator:authenticator1.assignedEntity.id.root
Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16824).
Pattern Value | 2.16.840.1.113883.4.6
274. ClinicalDocument.authenticator:authenticator1.assignedEntity.code
Comments | This assignedEntity MAY contain zero or one [0..1] code (CONF:4537-16825).
276. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.code
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).
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
278. ClinicalDocument.authenticator:authenticator1.assignedEntity.addr
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).
Control | 1..?
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
280. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5622).
Control | 1..?
282. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.use
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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
284. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5624).
Control | 1..?
286. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.name
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).
Control | 1..?
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
288. ClinicalDocument.participant
Invariants | 4537-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). () 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). ()
290. ClinicalDocument.participant.time
Comments | MAY contain zero or one [0..1] time (CONF:4537-10004).
292. ClinicalDocument.inFulfillmentOf
Comments | MAY contain zero or more [0..*] inFulfillmentOf (CONF:4537-9952).
294. ClinicalDocument.inFulfillmentOf.order
Comments | The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:4537-9953).
296. ClinicalDocument.inFulfillmentOf.order.id
Comments | This order SHALL contain at least one [1..*] id (CONF:4537-9954).
298. ClinicalDocument.documentationOf
Comments | MAY contain zero or more [0..*] documentationOf (CONF:4537-14835).
300. ClinicalDocument.documentationOf.serviceEvent
Comments | The documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:4537-14836).
302. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Comments | This serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:4537-14837).
Control | 1..?
304. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low
Comments | This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-14838).
Control | 1..?
306. ClinicalDocument.documentationOf.serviceEvent.performer
Comments | This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:4537-14839).
308. 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).
Control | 1..?
Binding | The codes SHALL be taken from x_ServiceEventPerformer
310. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode
Comments | The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:4537-16818).
312. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.code
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).
Binding | The codes SHOULD be taken from Care Team Member Function
314. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Comments | The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-14841).
316. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-14846).
318. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.root
Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-14847).
Pattern Value | 2.16.840.1.113883.4.6
320. 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).
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
322. ClinicalDocument.authorization
Comments | MAY contain zero or more [0..*] authorization (CONF:4537-16792) such that it
324. ClinicalDocument.authorization.consent
Comments | SHALL contain exactly one [1..1] consent (CONF:4537-16793).
326. ClinicalDocument.authorization.consent.id
Comments | This consent MAY contain zero or more [0..*] id (CONF:4537-16794).
328. ClinicalDocument.authorization.consent.code
Short | The 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).
330. ClinicalDocument.authorization.consent.statusCode
Comments | This consent SHALL contain exactly one [1..1] statusCode (CONF:4537-16797).
332. ClinicalDocument.authorization.consent.statusCode.code
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).
334. ClinicalDocument.componentOf
Comments | MAY contain zero or one [0..1] componentOf (CONF:4537-9955).
336. ClinicalDocument.componentOf.encompassingEncounter
Comments | The componentOf, if present, SHALL contain exactly one [1..1] encompassingEncounter (CONF:4537-9956).
338. ClinicalDocument.componentOf.encompassingEncounter.id
Comments | This encompassingEncounter SHALL contain at least one [1..*] id (CONF:4537-9959).
Control | 1..?
340. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime
Comments | This encompassingEncounter SHALL contain exactly one [1..1] effectiveTime (CONF:4537-9958).

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

0. ClinicalDocument
Definition | Base definition for all types defined in FHIR type system.
Short | Base for all types and resources
Control | 10..1*
Is Modifier | false
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
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).
Control | 1..1
Type | http://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.
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | US
6. ClinicalDocument.realmCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
8. ClinicalDocument.realmCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
10. ClinicalDocument.realmCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code 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.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
14. ClinicalDocument.realmCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
16. ClinicalDocument.realmCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
18. ClinicalDocument.realmCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
20. ClinicalDocument.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.
Comments | SHALL contain exactly one [1..1] typeId (CONF:4537-5361).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
22. ClinicalDocument.typeId.root
Comments | This typeId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.1.3" (CONF:4537-5250).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | 2.16.840.1.113883.1.3
24. ClinicalDocument.typeId.extension
Definition | An Extension
Short | Extension
Comments | This typeId SHALL contain exactly one [1..1] @extension="POCD_HD000040" (CONF:4537-5251).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | POCD_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
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This element introduces a set of slices on `ClinicalDocument.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ root value @ extension
28. ClinicalDocument.templateId:us-realm
Slice Name | us-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
Short | templateId
Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-5252) such that it
Control | 1..1
Type | http://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.
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.1" (CONF:4537-10036).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.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.
Comments | SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-32503).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | 2023-05-01
34. ClinicalDocument.id
Comments | SHALL contain exactly one [1..1] id (CONF:4537-5363).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | 4537-9991: This id **SHALL** be a globally unique identifier for the document (CONF:4537-9991). ()
36. ClinicalDocument.code
Comments | SHALL contain exactly one [1..1] code (CONF:4537-5253).
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from FHIRDocumentTypeCodes
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
Invariants | 4537-9992: This code **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992). () 4537-32948: This code **SHALL** be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:4537-32948). ()
38. ClinicalDocument.title
Short | The 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ST
40. 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.
Short | Base for all types and resources
Comments | SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5256).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-10127: **SHALL** be precise to the day (CONF:81-10127). () 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). () 81-10129: **MAY** be precise to the second (CONF:81-10129). () 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
42. 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).
Control | 1..1
Binding | The codes SHOULD be taken from HL7 BasicConfidentialityKind
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
44. ClinicalDocument.languageCode
Comments | SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:4537-5372).
Control | 1..1
Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
46. ClinicalDocument.setId
Comments | MAY contain zero or one [0..1] setId (CONF:4537-5261).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | 4537-6380: If setId is present versionNumber **SHALL** be present (CONF:4537-6380). ()
48. ClinicalDocument.versionNumber
Comments | MAY contain zero or one [0..1] versionNumber (CONF:4537-5264).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
Invariants | 4537-6387: If versionNumber is present setId **SHALL** be present (CONF:4537-6387). ()
50. ClinicalDocument.recordTarget
Comments | SHALL contain at least one [1..*] recordTarget (CONF:4537-5266).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
52. ClinicalDocument.recordTarget.patientRole
Comments | Such recordTargets SHALL contain exactly one [1..1] patientRole (CONF:4537-5267).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PatientRole
54. ClinicalDocument.recordTarget.patientRole.id
Comments | This patientRole SHALL contain at least one [1..*] id (CONF:4537-5268).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
56. 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 | Base for all types and resources
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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
58. ClinicalDocument.recordTarget.patientRole.telecom
Comments | This patientRole SHALL contain at least one [1..*] telecom (CONF:4537-5280).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
60. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
62. ClinicalDocument.recordTarget.patientRole.patient
Comments | This patientRole SHALL contain exactly one [1..1] patient (CONF:4537-5283).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Patient
64. 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.
Short | Base 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.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName(US Realm Patient Name (PTN.US.FIELDED))
Is Modifier | false
Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). ()
66. 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).
Control | 1..1
Binding | The codes SHALL be taken from Administrative Gender (HL7 V3)
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
68. ClinicalDocument.recordTarget.patientRole.patient.birthTime
Comments | This patient SHALL contain exactly one [1..1] birthTime (CONF:4537-5298).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Invariants | 4537-5299: **SHALL** be precise to year (CONF:4537-5299). () 4537-5300: **SHOULD** be precise to day (CONF:4537-5300). () 4537-32418: **MAY** be precise to the minute (CONF:4537-32418). ()
70. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd
Short | sdtc:deceasedInd
Comments | This patient MAY contain zero or one [0..1] sdtc:deceasedInd (CONF:4537-32990).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`deceasedInd`.
Invariants | 4537-32993: If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present (CONF:4537-32993). ()
72. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime
Short | sdtc:deceasedTime
Comments | This patient MAY contain zero or one [0..1] sdtc:deceasedTime (CONF:4537-32988).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`deceasedTime`.
74. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime.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.
Comments | The sdtc:deceasedTime, if present, SHOULD contain zero or one [0..1] @value (CONF:4537-32989).
Control | 0..1
Type | string(ts: Point in Time)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML Format | In the XML format, this property is represented as an attribute.
Invariants | 4537-32991: **SHALL** be precise to to the year (CONF:4537-32991). () 4537-32992: **SHOULD** be precise to the day (CONF:4537-32992). ()
76. 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).
Control | 0..1
Binding | The codes SHALL be taken from Marital Status
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
78. 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).
Control | 0..1
Binding | The codes SHALL be taken from Religious Affiliation
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
80. ClinicalDocument.recordTarget.patientRole.patient.raceCode
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).
Control | 1..1
Binding | The codes SHALL be taken from Race Category Excluding Nulls
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
82. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode
Short | 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).
Control | 0..*
Binding | The codes SHALL be taken from Race Value Set
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`raceCode`.
Invariants | 4537-31347: If sdtc:raceCode is present, then the patient **SHALL** contain [1..1] raceCode (CONF:4537-31347). ()
84. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode
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).
Control | 1..1
Binding | The codes SHALL be taken from Ethnicity
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
86. ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode
Short | ethnicGroupCode
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).
Control | 0..*
Binding | The codes SHALL be taken from Detailed Ethnicity
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`ethnicGroupCode`.
88. ClinicalDocument.recordTarget.patientRole.patient.guardian
Comments | This patient MAY contain zero or more [0..*] guardian (CONF:4537-5325).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Guardian
90. 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).
Control | 0..1
Binding | The codes SHALL be taken from Personal And Legal Relationship Role Type
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
92. 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.
Short | Base 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).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
94. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom
Comments | The guardian, if present, SHOULD contain zero or more [0..*] telecom (CONF:4537-5382).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
96. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
98. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson
Comments | The guardian, if present, SHALL contain exactly one [1..1] guardianPerson (CONF:4537-5385).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
100. 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). A name associated with the person.
Short | Base for all types and resourcesA name associated with the person
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). Person may have multiple names with different uses or applicable periods.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
102. ClinicalDocument.recordTarget.patientRole.patient.birthplace
Comments | This patient MAY contain zero or one [0..1] birthplace (CONF:4537-5395).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Birthplace
104. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place
Comments | The birthplace, if present, SHALL contain exactly one [1..1] place (CONF:4537-5396).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Place
106. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr
Comments | This place SHALL contain exactly one [1..1] addr (CONF:4537-5397).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Invariants | 4537-5402: If country is US, this addr **SHALL** contain exactly one [1..1] state, which **SHALL** be selected from ValueSet StateValueSet 2.16.840.1.113883.3.88.12.80.1 *DYNAMIC* (CONF:4537-5402). () 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). ()
108. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country
Definition | Country
Comments | This addr SHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:4537-5404).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
110. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication
Comments | This patient SHOULD contain zero or more [0..*] languageCommunication (CONF:4537-5406).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication
112. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode
Comments | The languageCommunication, if present, SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:4537-5407).
Control | 1..1
Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
114. 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).
Control | 0..1
Binding | The codes SHALL be taken from LanguageAbilityMode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
116. 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).
Control | 0..1
Binding | The codes SHALL be taken from LanguageAbilityProficiency
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
118. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd
Comments | The languageCommunication, if present, SHOULD contain zero or one [0..1] preferenceInd (CONF:4537-5414).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
120. ClinicalDocument.recordTarget.patientRole.providerOrganization
Comments | This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:4537-5416).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
122. ClinicalDocument.recordTarget.patientRole.providerOrganization.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] id (CONF:4537-5417). Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
Control | 10..*1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II id
Is Modifier | false
124. 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
126. ClinicalDocument.recordTarget.patientRole.providerOrganization.name
Definition | A name associated with the organization.
Short | Name used for the organization
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] name (CONF:4537-5419). If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.
Control | 10..*1 This element is affected by the following invariants: org-1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ON string
Is Modifier | false
Requirements | Need to use the name as the label of the organization.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
128. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] telecom (CONF:4537-5420).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
130. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
132. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
134. ClinicalDocument.author
Comments | SHALL contain at least one [1..*] author (CONF:4537-5444).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author
136. 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.
Short | Base for all types and resources
Comments | Such authors SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5445).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-10127: **SHALL** be precise to the day (CONF:81-10127). () 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). () 81-10129: **MAY** be precise to the second (CONF:81-10129). () 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
138. ClinicalDocument.author.assignedAuthor
Comments | Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:4537-5448).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor
Invariants | 4537-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). ()
140. 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This 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: , and can be differentiated using the following discriminators: value @ root
142. ClinicalDocument.author.assignedAuthor.id:id1
Slice Name | id1
Short | id
Comments | This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:4537-32882) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
144. ClinicalDocument.author.assignedAuthor.id:id1.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Comments | MAY contain zero or one [0..1] @nullFlavor="UNK" Unknown (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:4537-32883).
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
Fixed Value | UNK
146. ClinicalDocument.author.assignedAuthor.id:id1.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).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
148. ClinicalDocument.author.assignedAuthor.id:id1.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).
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
150. ClinicalDocument.author.assignedAuthor.code
Comments | This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:4537-16787).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System RoleCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
152. 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).
Control | 1..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
154. ClinicalDocument.author.assignedAuthor.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
156. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
158. ClinicalDocument.author.assignedAuthor.telecom
Comments | This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:4537-5428).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
160. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
162. ClinicalDocument.author.assignedAuthor.assignedPerson
Comments | This assignedAuthor SHOULD contain zero or one [0..1] assignedPerson (CONF:4537-5430).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
164. 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). A name associated with the person.
Short | Base for all types and resourcesA name associated with the person
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). Person may have multiple names with different uses or applicable periods.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
166. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice
Comments | This assignedAuthor SHOULD contain zero or one [0..1] assignedAuthoringDevice (CONF:4537-16783).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice
168. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName
Comments | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] manufacturerModelName (CONF:4537-16784).
Control | 1..1
Binding | For example codes, see Manufacturer Model Name Example
Type | http://hl7.org/cda/stds/core/StructureDefinition/SC
170. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName
Comments | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] softwareName (CONF:4537-16785).
Control | 1..1
Binding | For example codes, see Software Name Example
Type | http://hl7.org/cda/stds/core/StructureDefinition/SC
172. ClinicalDocument.dataEnterer
Comments | MAY contain zero or one [0..1] dataEnterer (CONF:4537-5441).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/DataEnterer
174. ClinicalDocument.dataEnterer.time
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
176. ClinicalDocument.dataEnterer.assignedEntity
Comments | The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5442).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
178. ClinicalDocument.dataEnterer.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5443).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
180. 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
182. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
184. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
186. ClinicalDocument.dataEnterer.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5466).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
188. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
190. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5469).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
192. 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). A name associated with the person.
Short | Base 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-5470). Person may have multiple names with different uses or applicable periods.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
194. ClinicalDocument.informant
Comments | MAY contain zero or more [0..*] informant (CONF:4537-31355) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
Slicing | This element introduces a set of slices on `ClinicalDocument.informant`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ relatedEntity
196. ClinicalDocument.informant:informant1
Slice Name | informant1
Short | informant
Comments | MAY contain zero or more [0..*] informant (CONF:4537-8001) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
198. ClinicalDocument.informant:informant1.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8002).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
200. ClinicalDocument.informant:informant1.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-9945).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | 4537-9946: If 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). ()
202. ClinicalDocument.informant:informant1.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).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
204. ClinicalDocument.informant:informant1.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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
206. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-8221).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
208. ClinicalDocument.informant:informant1.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.
Short | Base 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.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
210. ClinicalDocument.informant:informant2
Slice Name | informant2
Short | informant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
212. ClinicalDocument.informant:informant2.relatedEntity
Comments | SHALL contain exactly one [1..1] relatedEntity (CONF:4537-31356).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
214. ClinicalDocument.custodian
Comments | SHALL contain exactly one [1..1] custodian (CONF:4537-5519).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Custodian
216. ClinicalDocument.custodian.assignedCustodian
Comments | This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:4537-5520).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedCustodian
218. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
Comments | This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:4537-5521).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CustodianOrganization
220. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
Comments | This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:4537-5522).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
222. 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
224. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name
Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:4537-5524).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ON
226. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom
Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:4537-5525).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
228. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
230. 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.
Short | Base 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
232. ClinicalDocument.informationRecipient
Comments | MAY contain zero or more [0..*] informationRecipient (CONF:4537-5565).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient
234. ClinicalDocument.informationRecipient.intendedRecipient
Comments | The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:4537-5566).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IntendedRecipient
236. ClinicalDocument.informationRecipient.intendedRecipient.classCode
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | ASSIGNED
238. ClinicalDocument.informationRecipient.intendedRecipient.id
Comments | This intendedRecipient MAY contain zero or more [0..*] id (CONF:4537-32399).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
240. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient
Comments | This intendedRecipient MAY contain zero or one [0..1] informationRecipient (CONF:4537-5567).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
242. 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). A name associated with the person.
Short | Base for all types and resourcesA name associated with the person
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). Person may have multiple names with different uses or applicable periods.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
244. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization
Comments | This intendedRecipient MAY contain zero or one [0..1] receivedOrganization (CONF:4537-5577).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
246. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name
Definition | A name associated with the organization.
Short | Name used for the organization
Comments | The receivedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4537-5578). If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.
Control | 10..1 This element is affected by the following invariants: org-1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ON string
Is Modifier | false
Requirements | Need to use the name as the label of the organization.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
248. ClinicalDocument.legalAuthenticator
Comments | SHOULD contain zero or one [0..1] legalAuthenticator (CONF:4537-5579).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator
250. 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.
Short | Base for all types and resources
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5580).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-10127: **SHALL** be precise to the day (CONF:81-10127). () 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). () 81-10129: **MAY** be precise to the second (CONF:81-10129). () 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
252. ClinicalDocument.legalAuthenticator.signatureCode
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:4537-5583).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
254. 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).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | S
256. ClinicalDocument.legalAuthenticator.signatureCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
258. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
260. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
262. ClinicalDocument.legalAuthenticator.signatureCode.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
264. ClinicalDocument.legalAuthenticator.signatureCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
266. ClinicalDocument.legalAuthenticator.signatureCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
268. ClinicalDocument.legalAuthenticator.signatureCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
270. ClinicalDocument.legalAuthenticator.sdtcSignatureText
Short | The 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.
Comments | The legalAuthenticator, if present, MAY contain zero or one [0..1] sdtc:signatureText (CONF:4537-30810).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`signatureText`.
272. ClinicalDocument.legalAuthenticator.assignedEntity
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5585).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
274. ClinicalDocument.legalAuthenticator.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5586).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
276. 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.
Comments | Such ids MAY contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16823).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
278. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
280. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
282. ClinicalDocument.legalAuthenticator.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5595).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
284. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
286. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5597).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
288. 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). A name associated with the person.
Short | Base 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-5598). Person may have multiple names with different uses or applicable periods.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
290. ClinicalDocument.authenticator
Comments | MAY contain zero or more [0..*] authenticator (CONF:4537-5607) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authenticator
Slicing | This element introduces a set of slices on `ClinicalDocument.authenticator`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ ClinicalDocument.signatureCode value @ ClinicalDocument.assignedEntity value @ ClinicalDocument.time
292. ClinicalDocument.authenticator:authenticator1
Slice Name | authenticator1
Short | authenticator
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authenticator
294. ClinicalDocument.authenticator:authenticator1.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.
Short | Base for all types and resources
Comments | SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5608).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-10127: **SHALL** be precise to the day (CONF:81-10127). () 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). () 81-10129: **MAY** be precise to the second (CONF:81-10129). () 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
296. ClinicalDocument.authenticator:authenticator1.signatureCode
Comments | SHALL contain exactly one [1..1] signatureCode (CONF:4537-5610).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
298. ClinicalDocument.authenticator:authenticator1.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).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | S
300. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
302. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
304. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
306. ClinicalDocument.authenticator:authenticator1.signatureCode.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
308. ClinicalDocument.authenticator:authenticator1.signatureCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
310. ClinicalDocument.authenticator:authenticator1.signatureCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
312. ClinicalDocument.authenticator:authenticator1.signatureCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
314. ClinicalDocument.authenticator:authenticator1.sdtcSignatureText
Definition | Element Authenticator.sdtcSignatureText
Short | The 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.
Comments | MAY contain zero or one [0..1] sdtc:signatureText (CONF:4537-30811).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`signatureText`.
316. ClinicalDocument.authenticator:authenticator1.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5612).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
318. ClinicalDocument.authenticator:authenticator1.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5613).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
320. ClinicalDocument.authenticator:authenticator1.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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
322. ClinicalDocument.authenticator:authenticator1.assignedEntity.code
Comments | This assignedEntity MAY contain zero or one [0..1] code (CONF:4537-16825).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System RoleCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
324. ClinicalDocument.authenticator:authenticator1.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).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
326. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
328. ClinicalDocument.authenticator:authenticator1.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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
330. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5622).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
332. ClinicalDocument.authenticator:authenticator1.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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
334. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5624).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
336. ClinicalDocument.authenticator:authenticator1.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.
Short | Base 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-5625). Person may have multiple names with different uses or applicable periods.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
338. ClinicalDocument.participant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant1
Invariants | 4537-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). () 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). ()
340. ClinicalDocument.participant.time
Comments | MAY contain zero or one [0..1] time (CONF:4537-10004).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
342. ClinicalDocument.participant.associatedEntity
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
344. ClinicalDocument.inFulfillmentOf
Comments | MAY contain zero or more [0..*] inFulfillmentOf (CONF:4537-9952).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf
346. ClinicalDocument.inFulfillmentOf.order
Comments | The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:4537-9953).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Order
348. ClinicalDocument.inFulfillmentOf.order.classCode
Control | 1..1
Binding | The codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | ACT
350. ClinicalDocument.inFulfillmentOf.order.id
Comments | This order SHALL contain at least one [1..*] id (CONF:4537-9954).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
352. ClinicalDocument.documentationOf
Comments | MAY contain zero or more [0..*] documentationOf (CONF:4537-14835).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf
354. ClinicalDocument.documentationOf.serviceEvent
Comments | The documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:4537-14836).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent
356. ClinicalDocument.documentationOf.serviceEvent.classCode
Control | 1..1
Binding | The codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | ACT
358. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Comments | This serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:4537-14837).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
360. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low
Definition | This is the low limit of the interval.
Comments | This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-14838).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | Low Boundary
362. ClinicalDocument.documentationOf.serviceEvent.performer
Comments | This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:4537-14839).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer1
364. 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).
Control | 1..1
Binding | The codes SHALL be taken from x_ServiceEventPerformer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
366. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode
Comments | The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:4537-16818).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
368. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Care Team Member Function
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
370. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
372. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Comments | The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-14841).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
374. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-14846).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
376. 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
378. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
380. ClinicalDocument.authorization
Comments | MAY contain zero or more [0..*] authorization (CONF:4537-16792) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authorization
382. ClinicalDocument.authorization.consent
Comments | SHALL contain exactly one [1..1] consent (CONF:4537-16793).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Consent
384. ClinicalDocument.authorization.consent.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | This consent MAY contain zero or more [0..*] id (CONF:4537-16794). Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
Control | 0..*1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II id
Is Modifier | false
386. ClinicalDocument.authorization.consent.code
Short | The 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).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System ActCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
388. ClinicalDocument.authorization.consent.statusCode
Comments | This consent SHALL contain exactly one [1..1] statusCode (CONF:4537-16797).
Control | 1..1
Binding | The codes SHALL be taken from ActStatus
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
390. ClinicalDocument.authorization.consent.statusCode.code
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).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | completed
392. ClinicalDocument.componentOf
Comments | MAY contain zero or one [0..1] componentOf (CONF:4537-9955).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ComponentOf
394. ClinicalDocument.componentOf.encompassingEncounter
Comments | The componentOf, if present, SHALL contain exactly one [1..1] encompassingEncounter (CONF:4537-9956).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/EncompassingEncounter
396. ClinicalDocument.componentOf.encompassingEncounter.id
Comments | This encompassingEncounter SHALL contain at least one [1..*] id (CONF:4537-9959).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
398. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime
Comments | This encompassingEncounter SHALL contain exactly one [1..1] effectiveTime (CONF:4537-9958).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
400. ClinicalDocument.component
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Component

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

0. ClinicalDocument
Definition | Base definition for all types defined in FHIR type system.
Short | Base for all types and resources
Control | 1..1
Is Modifier | false
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
2. ClinicalDocument.classCode
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DOCCLIN
4. ClinicalDocument.moodCode
Control | 0..1
Binding | The codes SHALL be taken from ActMood
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | EVN
6. 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
8. ClinicalDocument.realmCode.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
10. 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.
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | US
12. ClinicalDocument.realmCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
14. ClinicalDocument.realmCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
16. ClinicalDocument.realmCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
18. ClinicalDocument.realmCode.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
20. 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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
22. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
24. ClinicalDocument.realmCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
26. ClinicalDocument.realmCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
28. ClinicalDocument.realmCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
30. ClinicalDocument.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.
Comments | SHALL contain exactly one [1..1] typeId (CONF:4537-5361).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
32. ClinicalDocument.typeId.root
Comments | This typeId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.1.3" (CONF:4537-5250).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | 2.16.840.1.113883.1.3
34. ClinicalDocument.typeId.extension
Definition | An Extension
Short | Extension
Comments | This typeId SHALL contain exactly one [1..1] @extension="POCD_HD000040" (CONF:4537-5251).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | POCD_HD000040
36. 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
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This element introduces a set of slices on `ClinicalDocument.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ root value @ extension
38. ClinicalDocument.templateId:us-realm
Slice Name | us-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
Short | templateId
Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-5252) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
40. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
42. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
44. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
46. 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.
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.1" (CONF:4537-10036).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.10.20.22.1.1
48. ClinicalDocument.templateId:us-realm.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Comments | SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-32503).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | 2023-05-01
50. ClinicalDocument.id
Comments | SHALL contain exactly one [1..1] id (CONF:4537-5363).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | 4537-9991: This id **SHALL** be a globally unique identifier for the document (CONF:4537-9991). ()
52. ClinicalDocument.code
Comments | SHALL contain exactly one [1..1] code (CONF:4537-5253).
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from FHIRDocumentTypeCodes
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
Invariants | 4537-9992: This code **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992). () 4537-32948: This code **SHALL** be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:4537-32948). ()
54. ClinicalDocument.title
Short | The 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ST
56. 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.
Short | Base for all types and resources
Comments | SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5256).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-10127: **SHALL** be precise to the day (CONF:81-10127). () 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). () 81-10129: **MAY** be precise to the second (CONF:81-10129). () 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
58. 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).
Control | 1..1
Binding | The codes SHOULD be taken from HL7 BasicConfidentialityKind
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
60. ClinicalDocument.languageCode
Comments | SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:4537-5372).
Control | 1..1
Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
62. ClinicalDocument.setId
Comments | MAY contain zero or one [0..1] setId (CONF:4537-5261).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | 4537-6380: If setId is present versionNumber **SHALL** be present (CONF:4537-6380). ()
64. ClinicalDocument.versionNumber
Comments | MAY contain zero or one [0..1] versionNumber (CONF:4537-5264).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
Invariants | 4537-6387: If versionNumber is present setId **SHALL** be present (CONF:4537-6387). ()
66. ClinicalDocument.copyTime
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
68. ClinicalDocument.recordTarget
Comments | SHALL contain at least one [1..*] recordTarget (CONF:4537-5266).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
70. ClinicalDocument.recordTarget.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
72. ClinicalDocument.recordTarget.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | RCT
74. ClinicalDocument.recordTarget.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
76. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
78. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
80. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
82. ClinicalDocument.recordTarget.patientRole
Comments | Such recordTargets SHALL contain exactly one [1..1] patientRole (CONF:4537-5267).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PatientRole
84. ClinicalDocument.recordTarget.patientRole.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassRelationshipFormal
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PAT
86. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
88. ClinicalDocument.recordTarget.patientRole.id
Comments | This patientRole SHALL contain at least one [1..*] id (CONF:4537-5268).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
90. ClinicalDocument.recordTarget.patientRole.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
92. 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 | Base for all types and resources
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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
94. ClinicalDocument.recordTarget.patientRole.telecom
Comments | This patientRole SHALL contain at least one [1..*] telecom (CONF:4537-5280).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
96. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
98. ClinicalDocument.recordTarget.patientRole.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
100. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
102. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
104. ClinicalDocument.recordTarget.patientRole.patient
Comments | This patientRole SHALL contain exactly one [1..1] patient (CONF:4537-5283).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Patient
106. ClinicalDocument.recordTarget.patientRole.patient.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
108. ClinicalDocument.recordTarget.patientRole.patient.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
110. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
112. ClinicalDocument.recordTarget.patientRole.patient.id
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
114. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Patient Name (PTN.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). ()
116. ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`desc`.
118. 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).
Control | 1..1
Binding | The codes SHALL be taken from Administrative Gender (HL7 V3)
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
120. ClinicalDocument.recordTarget.patientRole.patient.birthTime
Comments | This patient SHALL contain exactly one [1..1] birthTime (CONF:4537-5298).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Invariants | 4537-5299: **SHALL** be precise to year (CONF:4537-5299). () 4537-5300: **SHOULD** be precise to day (CONF:4537-5300). () 4537-32418: **MAY** be precise to the minute (CONF:4537-32418). ()
122. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd
Short | sdtc:deceasedInd
Comments | This patient MAY contain zero or one [0..1] sdtc:deceasedInd (CONF:4537-32990).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`deceasedInd`.
Invariants | 4537-32993: If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present (CONF:4537-32993). ()
124. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime
Short | sdtc:deceasedTime
Comments | This patient MAY contain zero or one [0..1] sdtc:deceasedTime (CONF:4537-32988).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`deceasedTime`.
126. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
128. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime.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.
Comments | The sdtc:deceasedTime, if present, SHOULD contain zero or one [0..1] @value (CONF:4537-32989).
Control | 0..1
Type | string(ts: Point in Time)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML Format | In the XML format, this property is represented as an attribute.
Invariants | 4537-32991: **SHALL** be precise to to the year (CONF:4537-32991). () 4537-32992: **SHOULD** be precise to the day (CONF:4537-32992). ()
130. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`multipleBirthInd`.
132. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT-POS
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`multipleBirthOrderNumber`.
134. 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).
Control | 0..1
Binding | The codes SHALL be taken from Marital Status
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
136. 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).
Control | 0..1
Binding | The codes SHALL be taken from Religious Affiliation
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
138. ClinicalDocument.recordTarget.patientRole.patient.raceCode
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).
Control | 1..1
Binding | The codes SHALL be taken from Race Category Excluding Nulls
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
140. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode
Short | 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).
Control | 0..*
Binding | The codes SHALL be taken from Race Value Set
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`raceCode`.
Invariants | 4537-31347: If sdtc:raceCode is present, then the patient **SHALL** contain [1..1] raceCode (CONF:4537-31347). ()
142. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode
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).
Control | 1..1
Binding | The codes SHALL be taken from Ethnicity
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
144. ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode
Short | ethnicGroupCode
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).
Control | 0..*
Binding | The codes SHALL be taken from Detailed Ethnicity
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`ethnicGroupCode`.
146. ClinicalDocument.recordTarget.patientRole.patient.guardian
Comments | This patient MAY contain zero or more [0..*] guardian (CONF:4537-5325).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Guardian
148. ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAgent
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | GUARD
150. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
152. ClinicalDocument.recordTarget.patientRole.patient.guardian.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
154. ClinicalDocument.recordTarget.patientRole.patient.guardian.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
156. 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).
Control | 0..1
Binding | The codes SHALL be taken from Personal And Legal Relationship Role Type
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
158. 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.
Short | Base 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).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
160. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom
Comments | The guardian, if present, SHOULD contain zero or more [0..*] telecom (CONF:4537-5382).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
162. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
164. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
166. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
168. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
170. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson
Comments | The guardian, if present, SHALL contain exactly one [1..1] guardianPerson (CONF:4537-5385).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
172. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
174. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
176. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
178. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
180. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
182. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
184. ClinicalDocument.recordTarget.patientRole.patient.birthplace
Comments | This patient MAY contain zero or one [0..1] birthplace (CONF:4537-5395).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Birthplace
186. ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassPassive
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | BIRTHPL
188. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
190. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place
Comments | The birthplace, if present, SHALL contain exactly one [1..1] place (CONF:4537-5396).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Place
192. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassPlace
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PLC
194. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
196. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
198. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/EN
200. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr
Comments | This place SHALL contain exactly one [1..1] addr (CONF:4537-5397).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Invariants | 4537-5402: If country is US, this addr **SHALL** contain exactly one [1..1] state, which **SHALL** be selected from ValueSet StateValueSet 2.16.840.1.113883.3.88.12.80.1 *DYNAMIC* (CONF:4537-5402). () 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). ()
202. 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.
Short | Primitive Type code
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Label | Exceptional Value Detail
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) cs-pattern: cs attributes must not contain any whitespace (`matches('^[^\\s]+$')`)
204. 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.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Is Not Ordered
206. 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.
Control | 0..*
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
208. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter
Definition | Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
210. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DEL
212. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country
Definition | Country
Comments | This addr SHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:4537-5404).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
214. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | CNT
216. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state
Definition | A sub-unit of a country with limited sovereignty in a federally organized country.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
218. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | STA
220. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.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".)
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
222. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | CPA
224. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city
Definition | The name of the city, town, village, or other community or delivery center
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
226. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | CTY
228. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode
Definition | A postal code designating a region defined by the postal service.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
230. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ZIP
232. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine
Definition | Street address line
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
234. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | SAL
236. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.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.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
238. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | BNR
240. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric
Definition | The numeric portion of a building number
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
242. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | BNN
244. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction
Definition | Direction (e.g., N, S, W, E)
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
246. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DIR
248. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName
Definition | Name of a roadway or artery recognized by a municipality (including street type and direction)
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
250. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | STR
252. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase
Definition | The base name of a roadway or artery recognized by a municipality (excluding street type and direction)
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
254. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | STB
256. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType
Definition | The designation given to the street. (e.g. Street, Avenue, Crescent, etc.)
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
258. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | STTYP
260. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.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).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
262. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ADL
264. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID
Definition | The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
266. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | UNID
268. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType
Definition | Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
270. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | UNIT
272. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
274. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | CAR
276. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract
Definition | A geographic sub-unit delineated for demographic purposes.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
278. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | CEN
280. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.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.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
282. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DAL
284. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.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.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
286. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DINST
288. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.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.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
290. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DINSTA
292. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier
Definition | A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
294. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DINSTQ
296. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode
Definition | Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
298. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DMOD
300. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.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).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
302. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DMODID
304. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix
Definition | Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
306. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | BNS
308. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox
Definition | A numbered box located in a post station.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
310. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | POB
312. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct
Definition | A subsection of a municipality
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
314. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PRE
316. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.other
Definition | Textual representation of (part of) the address
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as unadorned text.
318. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
320. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication
Comments | This patient SHOULD contain zero or more [0..*] languageCommunication (CONF:4537-5406).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication
322. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
324. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode
Comments | The languageCommunication, if present, SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:4537-5407).
Control | 1..1
Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
326. 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).
Control | 0..1
Binding | The codes SHALL be taken from LanguageAbilityMode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
328. 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).
Control | 0..1
Binding | The codes SHALL be taken from LanguageAbilityProficiency
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
330. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd
Comments | The languageCommunication, if present, SHOULD contain zero or one [0..1] preferenceInd (CONF:4537-5414).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
332. ClinicalDocument.recordTarget.patientRole.providerOrganization
Comments | This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:4537-5416).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
334. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
336. ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ORG
338. ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
340. ClinicalDocument.recordTarget.patientRole.providerOrganization.realmCode
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
342. ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
344. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
346. ClinicalDocument.recordTarget.patientRole.providerOrganization.id
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] id (CONF:4537-5417).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
348. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
350. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
352. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
354. 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
356. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
358. ClinicalDocument.recordTarget.patientRole.providerOrganization.name
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] name (CONF:4537-5419).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ON
360. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] telecom (CONF:4537-5420).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
362. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
364. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
366. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
368. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
370. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
372. ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from OrganizationIndustryClassNAICS
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
374. ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
376. ClinicalDocument.author
Comments | SHALL contain at least one [1..*] author (CONF:4537-5444).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author
378. ClinicalDocument.author.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
380. ClinicalDocument.author.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | AUT
382. ClinicalDocument.author.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
384. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
386. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
388. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
390. ClinicalDocument.author.functionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
392. 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.
Short | Base for all types and resources
Comments | Such authors SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5445).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-10127: **SHALL** be precise to the day (CONF:81-10127). () 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). () 81-10129: **MAY** be precise to the second (CONF:81-10129). () 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
394. ClinicalDocument.author.assignedAuthor
Comments | Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:4537-5448).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor
Invariants | 4537-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). ()
396. ClinicalDocument.author.assignedAuthor.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
398. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
400. 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This 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: , and can be differentiated using the following discriminators: value @ root
402. ClinicalDocument.author.assignedAuthor.id:id1
Slice Name | id1
Short | id
Comments | This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:4537-32882) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
404. ClinicalDocument.author.assignedAuthor.id:id1.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Comments | MAY contain zero or one [0..1] @nullFlavor="UNK" Unknown (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:4537-32883).
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
Fixed Value | UNK
406. ClinicalDocument.author.assignedAuthor.id:id1.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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
408. ClinicalDocument.author.assignedAuthor.id:id1.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
410. ClinicalDocument.author.assignedAuthor.id:id1.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).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
412. ClinicalDocument.author.assignedAuthor.id:id1.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).
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
414. ClinicalDocument.author.assignedAuthor.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
416. ClinicalDocument.author.assignedAuthor.code
Comments | This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:4537-16787).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System RoleCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
418. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
420. 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).
Control | 1..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
422. ClinicalDocument.author.assignedAuthor.code.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
424. ClinicalDocument.author.assignedAuthor.code.codeSystemName
Definition | The common name of the coding system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
426. ClinicalDocument.author.assignedAuthor.code.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
428. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
430. 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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
432. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
434. ClinicalDocument.author.assignedAuthor.code.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
436. ClinicalDocument.author.assignedAuthor.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
438. ClinicalDocument.author.assignedAuthor.code.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
440. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
442. ClinicalDocument.author.assignedAuthor.telecom
Comments | This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:4537-5428).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
444. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
446. ClinicalDocument.author.assignedAuthor.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
448. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
450. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
452. ClinicalDocument.author.assignedAuthor.assignedPerson
Comments | This assignedAuthor SHOULD contain zero or one [0..1] assignedPerson (CONF:4537-5430).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
454. ClinicalDocument.author.assignedAuthor.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
456. ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
458. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
460. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
462. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
464. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice
Comments | This assignedAuthor SHOULD contain zero or one [0..1] assignedAuthoringDevice (CONF:4537-16783).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice
466. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassDevice
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DEV
468. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
470. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
472. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.code
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from EntityCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
474. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName
Comments | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] manufacturerModelName (CONF:4537-16784).
Control | 1..1
Binding | For example codes, see Manufacturer Model Name Example
Type | http://hl7.org/cda/stds/core/StructureDefinition/SC
476. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName
Comments | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] softwareName (CONF:4537-16785).
Control | 1..1
Binding | For example codes, see Software Name Example
Type | http://hl7.org/cda/stds/core/StructureDefinition/SC
478. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/MaintainedEntity
480. ClinicalDocument.author.assignedAuthor.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
482. ClinicalDocument.dataEnterer
Comments | MAY contain zero or one [0..1] dataEnterer (CONF:4537-5441).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/DataEnterer
484. ClinicalDocument.dataEnterer.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
486. ClinicalDocument.dataEnterer.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ENT
488. ClinicalDocument.dataEnterer.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
490. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
492. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
494. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
496. ClinicalDocument.dataEnterer.time
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
498. ClinicalDocument.dataEnterer.assignedEntity
Comments | The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5442).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
500. ClinicalDocument.dataEnterer.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
502. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
504. ClinicalDocument.dataEnterer.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5443).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
506. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
508. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
510. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
512. 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
514. ClinicalDocument.dataEnterer.assignedEntity.id.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
516. ClinicalDocument.dataEnterer.assignedEntity.sdtcIdentifiedBy
Definition | Element AssignedEntity.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
518. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
520. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
522. ClinicalDocument.dataEnterer.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5466).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
524. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
526. ClinicalDocument.dataEnterer.assignedEntity.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
528. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
530. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
532. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5469).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
534. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
536. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
538. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
540. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
542. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
544. ClinicalDocument.dataEnterer.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
546. ClinicalDocument.informant
Comments | MAY contain zero or more [0..*] informant (CONF:4537-31355) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
Slicing | This element introduces a set of slices on `ClinicalDocument.informant`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ relatedEntity
548. ClinicalDocument.informant:informant1
Slice Name | informant1
Short | informant
Comments | MAY contain zero or more [0..*] informant (CONF:4537-8001) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
550. ClinicalDocument.informant:informant1.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
552. ClinicalDocument.informant:informant1.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
554. ClinicalDocument.informant:informant1.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
556. ClinicalDocument.informant:informant1.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
558. ClinicalDocument.informant:informant1.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INF
560. ClinicalDocument.informant:informant1.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
562. ClinicalDocument.informant:informant1.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8002).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
564. ClinicalDocument.informant:informant1.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
566. ClinicalDocument.informant:informant1.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
568. ClinicalDocument.informant:informant1.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-9945).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | 4537-9946: If 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). ()
570. ClinicalDocument.informant:informant1.assignedEntity.sdtcIdentifiedBy
Definition | Element AssignedEntity.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
572. ClinicalDocument.informant:informant1.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).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
574. ClinicalDocument.informant:informant1.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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
576. ClinicalDocument.informant:informant1.assignedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
578. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-8221).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
580. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
582. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
584. ClinicalDocument.informant:informant1.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
586. ClinicalDocument.informant:informant1.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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
588. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
590. ClinicalDocument.informant:informant1.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
592. ClinicalDocument.informant:informant1.relatedEntity
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
594. ClinicalDocument.informant:informant2
Slice Name | informant2
Short | informant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
596. ClinicalDocument.informant:informant2.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
598. ClinicalDocument.informant:informant2.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
600. ClinicalDocument.informant:informant2.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
602. ClinicalDocument.informant:informant2.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
604. ClinicalDocument.informant:informant2.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INF
606. ClinicalDocument.informant:informant2.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
608. ClinicalDocument.informant:informant2.assignedEntity
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
610. ClinicalDocument.informant:informant2.relatedEntity
Comments | SHALL contain exactly one [1..1] relatedEntity (CONF:4537-31356).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
612. ClinicalDocument.custodian
Comments | SHALL contain exactly one [1..1] custodian (CONF:4537-5519).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Custodian
614. ClinicalDocument.custodian.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
616. ClinicalDocument.custodian.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ENT
618. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
620. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
622. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
624. ClinicalDocument.custodian.assignedCustodian
Comments | This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:4537-5520).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedCustodian
626. ClinicalDocument.custodian.assignedCustodian.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
628. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
630. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
Comments | This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:4537-5521).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CustodianOrganization
632. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ORG
634. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
636. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
638. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
Comments | This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:4537-5522).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
640. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
642. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
644. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
646. 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
648. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
650. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name
Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:4537-5524).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ON
652. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom
Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:4537-5525).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
654. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
656. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
658. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
660. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
662. 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.
Short | Base 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
664. ClinicalDocument.informationRecipient
Comments | MAY contain zero or more [0..*] informationRecipient (CONF:4537-5565).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient
666. ClinicalDocument.informationRecipient.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
668. ClinicalDocument.informationRecipient.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | PRCP
670. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
672. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
674. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
676. ClinicalDocument.informationRecipient.intendedRecipient
Comments | The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:4537-5566).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IntendedRecipient
678. ClinicalDocument.informationRecipient.intendedRecipient.classCode
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | ASSIGNED
680. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
682. ClinicalDocument.informationRecipient.intendedRecipient.id
Comments | This intendedRecipient MAY contain zero or more [0..*] id (CONF:4537-32399).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
684. ClinicalDocument.informationRecipient.intendedRecipient.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
686. ClinicalDocument.informationRecipient.intendedRecipient.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
688. ClinicalDocument.informationRecipient.intendedRecipient.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
690. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient
Comments | This intendedRecipient MAY contain zero or one [0..1] informationRecipient (CONF:4537-5567).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
692. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
694. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
696. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
698. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
700. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
702. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization
Comments | This intendedRecipient MAY contain zero or one [0..1] receivedOrganization (CONF:4537-5577).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
704. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
706. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ORG
708. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
710. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.realmCode
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
712. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
714. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
716. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
718. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name
Comments | The receivedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4537-5578).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ON
720. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
722. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
724. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCode
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from OrganizationIndustryClassNAICS
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
726. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
728. ClinicalDocument.legalAuthenticator
Comments | SHOULD contain zero or one [0..1] legalAuthenticator (CONF:4537-5579).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator
730. ClinicalDocument.legalAuthenticator.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
732. ClinicalDocument.legalAuthenticator.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | LA
734. ClinicalDocument.legalAuthenticator.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
736. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
738. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
740. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
742. 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.
Short | Base for all types and resources
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5580).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-10127: **SHALL** be precise to the day (CONF:81-10127). () 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). () 81-10129: **MAY** be precise to the second (CONF:81-10129). () 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
744. ClinicalDocument.legalAuthenticator.signatureCode
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:4537-5583).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
746. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
748. 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).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | S
750. ClinicalDocument.legalAuthenticator.signatureCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
752. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
754. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
756. ClinicalDocument.legalAuthenticator.signatureCode.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
758. 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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
760. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
762. ClinicalDocument.legalAuthenticator.signatureCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
764. ClinicalDocument.legalAuthenticator.signatureCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
766. ClinicalDocument.legalAuthenticator.signatureCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
768. ClinicalDocument.legalAuthenticator.sdtcSignatureText
Short | The 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.
Comments | The legalAuthenticator, if present, MAY contain zero or one [0..1] sdtc:signatureText (CONF:4537-30810).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`signatureText`.
770. ClinicalDocument.legalAuthenticator.assignedEntity
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5585).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
772. ClinicalDocument.legalAuthenticator.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
774. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
776. ClinicalDocument.legalAuthenticator.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5586).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
778. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
780. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
782. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
784. 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.
Comments | Such ids MAY contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16823).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
786. ClinicalDocument.legalAuthenticator.assignedEntity.id.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
788. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcIdentifiedBy
Definition | Element AssignedEntity.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
790. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
792. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
794. ClinicalDocument.legalAuthenticator.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5595).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
796. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
798. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
800. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
802. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
804. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5597).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
806. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
808. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
810. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
812. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
814. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
816. ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
818. ClinicalDocument.authenticator
Comments | MAY contain zero or more [0..*] authenticator (CONF:4537-5607) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authenticator
Slicing | This element introduces a set of slices on `ClinicalDocument.authenticator`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ ClinicalDocument.signatureCode value @ ClinicalDocument.assignedEntity value @ ClinicalDocument.time
820. ClinicalDocument.authenticator:authenticator1
Slice Name | authenticator1
Short | authenticator
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authenticator
822. ClinicalDocument.authenticator:authenticator1.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
824. ClinicalDocument.authenticator:authenticator1.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | AUTHEN
826. ClinicalDocument.authenticator:authenticator1.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
828. ClinicalDocument.authenticator:authenticator1.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
830. ClinicalDocument.authenticator:authenticator1.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
832. ClinicalDocument.authenticator:authenticator1.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.
Short | Base for all types and resources
Comments | SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5608).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-10127: **SHALL** be precise to the day (CONF:81-10127). () 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). () 81-10129: **MAY** be precise to the second (CONF:81-10129). () 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
834. ClinicalDocument.authenticator:authenticator1.signatureCode
Comments | SHALL contain exactly one [1..1] signatureCode (CONF:4537-5610).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
836. ClinicalDocument.authenticator:authenticator1.signatureCode.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
838. ClinicalDocument.authenticator:authenticator1.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).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | S
840. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
842. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
844. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
846. ClinicalDocument.authenticator:authenticator1.signatureCode.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
848. ClinicalDocument.authenticator:authenticator1.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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
850. ClinicalDocument.authenticator:authenticator1.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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
852. ClinicalDocument.authenticator:authenticator1.signatureCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
854. ClinicalDocument.authenticator:authenticator1.signatureCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
856. ClinicalDocument.authenticator:authenticator1.signatureCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
858. ClinicalDocument.authenticator:authenticator1.sdtcSignatureText
Definition | Element Authenticator.sdtcSignatureText
Short | The 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.
Comments | MAY contain zero or one [0..1] sdtc:signatureText (CONF:4537-30811).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`signatureText`.
860. ClinicalDocument.authenticator:authenticator1.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5612).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
862. ClinicalDocument.authenticator:authenticator1.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
864. ClinicalDocument.authenticator:authenticator1.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
866. ClinicalDocument.authenticator:authenticator1.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5613).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
868. ClinicalDocument.authenticator:authenticator1.assignedEntity.id.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
870. ClinicalDocument.authenticator:authenticator1.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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
872. ClinicalDocument.authenticator:authenticator1.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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
874. ClinicalDocument.authenticator:authenticator1.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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
876. ClinicalDocument.authenticator:authenticator1.assignedEntity.id.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
878. ClinicalDocument.authenticator:authenticator1.assignedEntity.sdtcIdentifiedBy
Definition | Element AssignedEntity.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
880. ClinicalDocument.authenticator:authenticator1.assignedEntity.code
Comments | This assignedEntity MAY contain zero or one [0..1] code (CONF:4537-16825).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System RoleCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
882. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
884. ClinicalDocument.authenticator:authenticator1.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).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
886. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
888. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codeSystemName
Definition | The common name of the coding system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
890. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
892. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
894. ClinicalDocument.authenticator:authenticator1.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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
896. ClinicalDocument.authenticator:authenticator1.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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
898. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
900. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
902. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
904. ClinicalDocument.authenticator:authenticator1.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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
906. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5622).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
908. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
910. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
912. ClinicalDocument.authenticator:authenticator1.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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
914. ClinicalDocument.authenticator:authenticator1.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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
916. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5624).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
918. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
920. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
922. ClinicalDocument.authenticator:authenticator1.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
924. ClinicalDocument.authenticator:authenticator1.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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
926. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
928. ClinicalDocument.authenticator:authenticator1.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
930. ClinicalDocument.participant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant1
Invariants | 4537-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). () 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). ()
932. ClinicalDocument.participant.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
934. ClinicalDocument.participant.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
936. ClinicalDocument.participant.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
938. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
940. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
942. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
944. ClinicalDocument.participant.functionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
946. ClinicalDocument.participant.time
Comments | MAY contain zero or one [0..1] time (CONF:4537-10004).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
948. ClinicalDocument.participant.associatedEntity
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
950. ClinicalDocument.inFulfillmentOf
Comments | MAY contain zero or more [0..*] inFulfillmentOf (CONF:4537-9952).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf
952. ClinicalDocument.inFulfillmentOf.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
954. ClinicalDocument.inFulfillmentOf.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | FLFS
956. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
958. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
960. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
962. ClinicalDocument.inFulfillmentOf.order
Comments | The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:4537-9953).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Order
964. ClinicalDocument.inFulfillmentOf.order.classCode
Control | 1..1
Binding | The codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | ACT
966. ClinicalDocument.inFulfillmentOf.order.moodCode
Control | 0..1
Binding | The codes SHALL be taken from ActMoodIntent
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | RQO
968. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
970. ClinicalDocument.inFulfillmentOf.order.id
Comments | This order SHALL contain at least one [1..*] id (CONF:4537-9954).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
972. ClinicalDocument.inFulfillmentOf.order.code
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System ActCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
974. ClinicalDocument.inFulfillmentOf.order.priorityCode
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActPriority
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
976. ClinicalDocument.documentationOf
Comments | MAY contain zero or more [0..*] documentationOf (CONF:4537-14835).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf
978. ClinicalDocument.documentationOf.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
980. ClinicalDocument.documentationOf.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DOC
982. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
984. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
986. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
988. ClinicalDocument.documentationOf.serviceEvent
Comments | The documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:4537-14836).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent
990. ClinicalDocument.documentationOf.serviceEvent.classCode
Control | 1..1
Binding | The codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | ACT
992. ClinicalDocument.documentationOf.serviceEvent.moodCode
Control | 0..1
Binding | The codes SHALL be taken from ActMood
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | EVN
994. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
996. ClinicalDocument.documentationOf.serviceEvent.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
998. ClinicalDocument.documentationOf.serviceEvent.code
Definition | Drawn from concept domain ActCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1000. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Comments | This serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:4537-14837).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
1002. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1004. 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.
Control | 0..1
Type | string(ts: Point in Time)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML Format | In the XML format, this property is represented as an attribute.
1006. 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.
Control | 0..1
Binding | The codes SHALL be taken from SetOperator
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | I
1008. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low
Definition | This is the low limit of the interval.
Comments | This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-14838).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | Low Boundary
1010. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Label | Central Value
1012. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ
Label | Width
1014. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
Definition | This is the high limit of the interval.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | High Boundary
1016. ClinicalDocument.documentationOf.serviceEvent.performer
Comments | This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:4537-14839).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer1
1018. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1020. 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).
Control | 1..1
Binding | The codes SHALL be taken from x_ServiceEventPerformer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
1022. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1024. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1026. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1028. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode
Comments | The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:4537-16818).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1030. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1032. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Care Team Member Function
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
1034. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
1036. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
1038. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
1040. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
1042. 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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
1044. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
1046. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
1048. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
1050. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
1052. ClinicalDocument.documentationOf.serviceEvent.performer.time
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
1054. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Comments | The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-14841).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1056. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
1058. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1060. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-14846).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1062. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1064. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
1066. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
1068. 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
1070. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
1072. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy
Definition | Element AssignedEntity.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
1074. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1076. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
1078. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
1080. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
1082. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1084. ClinicalDocument.relatedDocument
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument
1086. ClinicalDocument.authorization
Comments | MAY contain zero or more [0..*] authorization (CONF:4537-16792) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authorization
1088. ClinicalDocument.authorization.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1090. ClinicalDocument.authorization.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | AUTH
1092. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1094. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1096. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1098. ClinicalDocument.authorization.consent
Comments | SHALL contain exactly one [1..1] consent (CONF:4537-16793).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Consent
1100. ClinicalDocument.authorization.consent.classCode
Control | 0..1
Binding | The codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | CONS
1102. ClinicalDocument.authorization.consent.moodCode
Control | 0..1
Binding | The codes SHALL be taken from ActMood
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | EVN
1104. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1106. ClinicalDocument.authorization.consent.id
Comments | This consent MAY contain zero or more [0..*] id (CONF:4537-16794).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1108. ClinicalDocument.authorization.consent.code
Short | The 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).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System ActCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1110. ClinicalDocument.authorization.consent.statusCode
Comments | This consent SHALL contain exactly one [1..1] statusCode (CONF:4537-16797).
Control | 1..1
Binding | The codes SHALL be taken from ActStatus
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1112. ClinicalDocument.authorization.consent.statusCode.code
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).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | completed
1114. ClinicalDocument.componentOf
Comments | MAY contain zero or one [0..1] componentOf (CONF:4537-9955).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ComponentOf
1116. ClinicalDocument.componentOf.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1118. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1120. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1122. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1124. ClinicalDocument.componentOf.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ActRelationshipHasComponent
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1126. ClinicalDocument.componentOf.encompassingEncounter
Comments | The componentOf, if present, SHALL contain exactly one [1..1] encompassingEncounter (CONF:4537-9956).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/EncompassingEncounter
1128. ClinicalDocument.componentOf.encompassingEncounter.classCode
Control | 0..1
Binding | The codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ENC
1130. ClinicalDocument.componentOf.encompassingEncounter.moodCode
Control | 0..1
Binding | The codes SHALL be taken from ActMood
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | EVN
1132. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1134. ClinicalDocument.componentOf.encompassingEncounter.id
Comments | This encompassingEncounter SHALL contain at least one [1..*] id (CONF:4537-9959).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1136. ClinicalDocument.componentOf.encompassingEncounter.code
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActEncounterCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1138. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime
Comments | This encompassingEncounter SHALL contain exactly one [1..1] effectiveTime (CONF:4537-9958).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
1140. ClinicalDocument.componentOf.encompassingEncounter.sdtcAdmissionReferralSourceCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`admissionReferralSourceCode`.
1142. ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from USEncounterDischargeDisposition
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1144. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1146. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1148. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1150. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1152. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1154. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | RESP
1156. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1158. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant
1160. 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).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1162. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1164. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1166. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1168. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1170. ClinicalDocument.componentOf.encompassingEncounter.location.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationTargetLocation
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | LOC
1172. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility
1174. ClinicalDocument.component
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Component