Consolidated CDA Release 2.2
2.2 - CI Build United States of America flag

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

Resource Profile: CarePlan - Detailed Descriptions

Active as of 2022-05-13

Definitions for the 2.16.840.1.113883.10.20.22.1.15 resource profile.

1. ClinicalDocument
Control1..1
2. ClinicalDocument.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass; other codes may be used where these codes are not suitable
Typecode
Default ValueDOCCLIN
Fixed ValueDOCCLIN
3. ClinicalDocument.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
Default ValueEVN
Fixed ValueEVN
4. 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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

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

Pattern ValueUS
5. 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.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

6. ClinicalDocument.typeId.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
7. ClinicalDocument.typeId.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring
8. ClinicalDocument.typeId.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
9. ClinicalDocument.typeId.root
Definition

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

Control1..1
Typestring
Requirements

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

Pattern Value2.16.840.1.113883.1.3
10. ClinicalDocument.typeId.extension
Definition

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

Control1..1
Typestring
Requirements

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

Pattern ValuePOCD_HD000040
11. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on ClinicalDocument.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • ,
  • value @ extension
12. ClinicalDocument.templateId:primary
SliceNameprimary
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1198-5252) such that it

13. ClinicalDocument.templateId:primary.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
14. ClinicalDocument.templateId:primary.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring
15. ClinicalDocument.templateId:primary.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
16. ClinicalDocument.templateId:primary.root
Definition

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

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.1" (CONF:1198-10036).

Pattern Value2.16.840.1.113883.10.20.22.1.1
17. ClinicalDocument.templateId:primary.extension
Definition

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

Control1..1
Typestring
Requirements

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

Pattern Value2015-08-01
18. ClinicalDocument.templateId:secondary
SliceNamesecondary
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1198-28741) such that it

InvariantsDefined on this element
1198-32934: When asserting this templateId, all C-CDA 2.1 section and entry templates that had a previous version in C-CDA R1.1 **SHALL** include both the C-CDA 2.1 templateId and the C-CDA R1.1 templateId root without an extension. See C-CDA R2.1 Volume 1 - Design Considerations for additional detail (CONF:1198-32934). (: )
19. ClinicalDocument.templateId:secondary.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
20. ClinicalDocument.templateId:secondary.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring
21. ClinicalDocument.templateId:secondary.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
22. ClinicalDocument.templateId:secondary.root
Definition

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

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.15" (CONF:1198-28742).

Pattern Value2.16.840.1.113883.10.20.22.1.15
23. ClinicalDocument.templateId:secondary.extension
Definition

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

Control1..1
Typestring
Requirements

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

Pattern Value2015-08-01
24. ClinicalDocument.id
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

InvariantsDefined on this element
1198-9991: This id **SHALL** be a globally unique identifier for the document (CONF:1198-9991). (: )
25. ClinicalDocument.code
Control1..1
BindingThe codes SHALL be taken from http://terminology.hl7.org/ValueSet/v3-DocumentType; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

InvariantsDefined on this element
1198-32948: This code **SHALL** be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:1198-32948). (: )
1198-9992: This code **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:1198-9992). (: )
26. ClinicalDocument.code.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
27. ClinicalDocument.code.code
Definition

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

Control1..1
BindingThe codes SHALL be taken from Care Plan Document Type
Typestring
Requirements

This code SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet Care Plan Document Type urn:oid:2.16.840.1.113762.1.4.1099.10 DYNAMIC (CONF:1198-32959).

28. ClinicalDocument.code.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
29. ClinicalDocument.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
30. ClinicalDocument.code.codeSystemVersion
Definition

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

Control0..1
Typestring
31. ClinicalDocument.code.displayName
Definition

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

Control0..1
Typestring
32. ClinicalDocument.code.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
33. ClinicalDocument.code.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
34. ClinicalDocument.code.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
35. ClinicalDocument.code.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
36. ClinicalDocument.code.translation
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
37. ClinicalDocument.title
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ST
Requirements

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

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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS(USRealmDateandTimeDTMUSFIELDED)
Requirements

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

InvariantsDefined on this element
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). (: )
39. ClinicalDocument.confidentialityCode
Control1..1
BindingThe codes SHOULD be taken from HL7 BasicConfidentialityKind
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

40. ClinicalDocument.languageCode
Control1..1
BindingThe codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

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

41. ClinicalDocument.setId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHOULD contain zero or one [0..1] setId (CONF:1198-32321).

InvariantsDefined on this element
1198-6380: If setId is present versionNumber **SHALL** be present (CONF:1198-6380). (: )
42. ClinicalDocument.versionNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
Requirements

SHOULD contain zero or one [0..1] versionNumber (CONF:1198-32322).

InvariantsDefined on this element
1198-6387: If versionNumber is present setId **SHALL** be present (CONF:1198-6387). (: )
43. ClinicalDocument.copyTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
44. ClinicalDocument.recordTarget
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/RecordTarget
Requirements

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

45. ClinicalDocument.recordTarget.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
46. ClinicalDocument.recordTarget.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueRCT
47. ClinicalDocument.recordTarget.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Fixed ValueOP
48. ClinicalDocument.recordTarget.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
49. ClinicalDocument.recordTarget.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
50. ClinicalDocument.recordTarget.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
51. ClinicalDocument.recordTarget.patientRole
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PatientRole
Requirements

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

52. ClinicalDocument.recordTarget.patientRole.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassRelationshipFormal
Typecode
Default ValuePAT
Fixed ValuePAT
53. ClinicalDocument.recordTarget.patientRole.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
54. ClinicalDocument.recordTarget.patientRole.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

55. ClinicalDocument.recordTarget.patientRole.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
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.

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED)
Requirements

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

InvariantsDefined on this element
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: )
57. ClinicalDocument.recordTarget.patientRole.telecom
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Requirements

This patientRole SHALL contain at least one [1..*] telecom (CONF:1198-5280).

58. ClinicalDocument.recordTarget.patientRole.telecom.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
59. ClinicalDocument.recordTarget.patientRole.telecom.value
Control0..1
Typeuri
60. ClinicalDocument.recordTarget.patientRole.telecom.useablePeriod
Definition

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

Control0..*
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
61. 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.

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
Typecode
Requirements

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

62. ClinicalDocument.recordTarget.patientRole.patient
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Patient
Requirements

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

63. ClinicalDocument.recordTarget.patientRole.patient.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
Default ValuePSN
Fixed ValuePSN
64. ClinicalDocument.recordTarget.patientRole.patient.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
65. ClinicalDocument.recordTarget.patientRole.patient.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
66. ClinicalDocument.recordTarget.patientRole.patient.id
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
67. 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).

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPatientNamePTNUSFIELDED)
Requirements

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

InvariantsDefined on this element
81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). (: )
68. ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
69. ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode
Control1..1
BindingThe codes SHALL be taken from Administrative Gender (HL7 V3)
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

70. ClinicalDocument.recordTarget.patientRole.patient.birthTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Requirements

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

InvariantsDefined on this element
1198-32418: **MAY** be precise to the minute (CONF:1198-32418). For cases where information about newborn's time of birth needs to be captured. (: )
1198-5299: **SHALL** be precise to year (CONF:1198-5299). (: )
1198-5300: **SHOULD** be precise to day (CONF:1198-5300). (: )
71. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
72. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
73. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
74. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT-POS
75. ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode
Control0..1
BindingThe codes SHALL be taken from Marital Status
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

76. ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode
Control0..1
BindingThe codes SHALL be taken from Religious Affiliation
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

77. ClinicalDocument.recordTarget.patientRole.patient.raceCode
Control1..1
BindingThe codes SHALL be taken from Race Category Excluding Nulls
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

78. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode
Control0..*
BindingThe codes SHALL be taken from Race Value Set; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

79. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode
Control1..1
BindingThe codes SHALL be taken from Ethnicity
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

80. ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode
Control0..*
BindingThe codes SHALL be taken from Detailed Ethnicity; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

81. ClinicalDocument.recordTarget.patientRole.patient.guardian
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Guardian
Requirements

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

82. ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAgent
Typecode
Default ValueGUARD
Fixed ValueGUARD
83. ClinicalDocument.recordTarget.patientRole.patient.guardian.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
84. ClinicalDocument.recordTarget.patientRole.patient.guardian.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
85. ClinicalDocument.recordTarget.patientRole.patient.guardian.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
86. ClinicalDocument.recordTarget.patientRole.patient.guardian.code
Control0..1
BindingThe codes SHALL be taken from Personal And Legal Relationship Role Type
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED)
Requirements

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

InvariantsDefined on this element
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: )
88. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Requirements

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

89. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
90. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value
Control0..1
Typeuri
91. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.useablePeriod
Definition

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

Control0..*
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
92. 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.

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
Typecode
Requirements

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

93. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
Requirements

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

94. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
Default ValuePSN
Fixed ValuePSN
95. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
96. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
97. 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).

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED)
Requirements

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

InvariantsDefined on this element
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). (: )
98. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
99. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
100. ClinicalDocument.recordTarget.patientRole.patient.birthplace
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Birthplace
Requirements

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

101. ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassPassive
Typecode
Default ValueBIRTHPL
Fixed ValueBIRTHPL
102. ClinicalDocument.recordTarget.patientRole.patient.birthplace.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
103. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Place
Requirements

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

104. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassPlace
Typecode
Default ValuePLC
Fixed ValuePLC
105. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
106. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
107. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/EN
108. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
Requirements

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

InvariantsDefined on this element
1198-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:1198-5402). (: )
1198-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:1198-5403). (: )
109. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
110. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.isNotOrdered
Definition

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

Control0..1
Typeboolean
111. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.use
Definition

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

Control0..*
Typecode
112. 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.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
113. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueDEL
114. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country
Definition

Country

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

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

115. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueCNT
116. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
117. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueSTA
118. 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".)

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
119. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueCPA
120. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
121. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueCTY
122. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
123. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueZIP
124. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine
Definition

Street address line

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
125. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueSAL
126. 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.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
127. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueBNR
128. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric
Definition

The numeric portion of a building number

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
129. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueBNN
130. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
131. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueDIR
132. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
133. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueSTR
134. 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)

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
135. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueSTB
136. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
137. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueSTTYP
138. 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).

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
139. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueADL
140. 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.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
141. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueUNID
142. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
143. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueUNIT
144. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
145. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueCAR
146. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract
Definition

A geographic sub-unit delineated for demographic purposes.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
147. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueCEN
148. 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.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
149. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueDAL
150. 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.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
151. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueDINST
152. 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.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
153. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueDINSTA
154. 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'.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
155. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueDINSTQ
156. 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.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
157. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueDMOD
158. 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).

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
159. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueDMODID
160. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
161. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValueBNS
162. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox
Definition

A numbered box located in a post station.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
163. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValuePOB
164. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct
Definition

A subsection of a municipality

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
165. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
Fixed ValuePRE
166. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.other
Definition

Textual representation of (part of) the address

Control0..1
Typestring
167. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.useablePeriod[x]
Definition

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

Control0..*
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
[x] NoteSee Choice of Data Types for further information about how to use [x]
168. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/LanguageCommunication
Requirements

This patient SHOULD contain zero or more [0..*] languageCommunication (CONF:1198-5406).

169. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
170. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode
Control1..1
BindingThe codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

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

171. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCode
Control0..1
BindingThe codes SHALL be taken from LanguageAbilityMode
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

172. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode
Control0..1
BindingThe codes SHALL be taken from LanguageAbilityProficiency
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

173. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
Requirements

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

174. ClinicalDocument.recordTarget.patientRole.providerOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
Requirements

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

175. ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassOrganization
Typecode
Default ValueORG
Fixed ValueORG
176. ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
177. ClinicalDocument.recordTarget.patientRole.providerOrganization.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
178. ClinicalDocument.recordTarget.patientRole.providerOrganization.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

179. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
180. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring
181. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
182. 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.

Control0..1
Typestring
Requirements

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

Pattern Value2.16.840.1.113883.4.6
183. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension
Definition

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

Control0..1
Typestring
184. ClinicalDocument.recordTarget.patientRole.providerOrganization.name
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ON
Requirements

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

185. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Requirements

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

186. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
187. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value
Control0..1
Typeuri
188. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.useablePeriod
Definition

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

Control0..*
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
189. 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.

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
Typecode
Requirements

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

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

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED)
Requirements

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

InvariantsDefined on this element
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: )
191. ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode
Control0..1
BindingThe codes SHALL be taken from OrganizationIndustryClassNAICS; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
192. ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/OrganizationPartOf
193. ClinicalDocument.author
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
Requirements

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

194. ClinicalDocument.author.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
195. ClinicalDocument.author.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueAUT
196. ClinicalDocument.author.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Fixed ValueOP
197. ClinicalDocument.author.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
198. ClinicalDocument.author.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
199. ClinicalDocument.author.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
200. ClinicalDocument.author.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
201. 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.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS(USRealmDateandTimeDTMUSFIELDED)
Requirements

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

InvariantsDefined on this element
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). (: )
202. ClinicalDocument.author.assignedAuthor
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedAuthor
Requirements

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

InvariantsDefined on this element
1198-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:1198-16790). (: )
203. ClinicalDocument.author.assignedAuthor.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
Default ValueASSIGNED
Fixed ValueASSIGNED
204. ClinicalDocument.author.assignedAuthor.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
205. ClinicalDocument.author.assignedAuthor.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
InvariantsDefined on this element
1198-5449: If this assignedAuthor is not an assignedPerson, this assignedAuthor SHALL contain at least one [1..*] id (CONF:1198-5449). (: )
SlicingThis element introduces a set of slices on ClinicalDocument.author.assignedAuthor.id. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
206. ClinicalDocument.author.assignedAuthor.id:id1
SliceNameid1
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:1198-32882) such that it

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
Requirements

MAY contain zero or one [0..1] @nullFlavor="UNK" Unknown (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:1198-32883).

Pattern ValueUNK
208. 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.

Control0..1
Typestring
209. 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).

Control0..1
Typeboolean
210. 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.

Control1..1
Typestring
Requirements

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

Pattern Value2.16.840.1.113883.4.6
211. ClinicalDocument.author.assignedAuthor.id:id1.extension
Definition

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

Control0..1
Typestring
Requirements

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

212. ClinicalDocument.author.assignedAuthor.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
213. ClinicalDocument.author.assignedAuthor.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

214. ClinicalDocument.author.assignedAuthor.code.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
215. 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.

Control1..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typestring
Requirements

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

216. ClinicalDocument.author.assignedAuthor.code.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
217. ClinicalDocument.author.assignedAuthor.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
218. ClinicalDocument.author.assignedAuthor.code.codeSystemVersion
Definition

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

Control0..1
Typestring
219. ClinicalDocument.author.assignedAuthor.code.displayName
Definition

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

Control0..1
Typestring
220. ClinicalDocument.author.assignedAuthor.code.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
221. ClinicalDocument.author.assignedAuthor.code.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
222. ClinicalDocument.author.assignedAuthor.code.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
223. ClinicalDocument.author.assignedAuthor.code.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
224. ClinicalDocument.author.assignedAuthor.code.translation
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
225. 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.

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED)
Requirements

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

InvariantsDefined on this element
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: )
226. ClinicalDocument.author.assignedAuthor.telecom
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Requirements

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

227. ClinicalDocument.author.assignedAuthor.telecom.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
228. ClinicalDocument.author.assignedAuthor.telecom.value
Control0..1
Typeuri
229. ClinicalDocument.author.assignedAuthor.telecom.useablePeriod
Definition

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

Control0..*
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
230. 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.

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
Typecode
Requirements

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

231. ClinicalDocument.author.assignedAuthor.assignedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
Requirements

This assignedAuthor SHOULD contain zero or one [0..1] assignedPerson (CONF:1198-5430).

232. ClinicalDocument.author.assignedAuthor.assignedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
Default ValuePSN
Fixed ValuePSN
233. ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
234. ClinicalDocument.author.assignedAuthor.assignedPerson.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
235. 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).

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED)
Requirements

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

InvariantsDefined on this element
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). (: )
236. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
237. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AuthoringDevice
Requirements

This assignedAuthor SHOULD contain zero or one [0..1] assignedAuthoringDevice (CONF:1198-16783).

238. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassDevice
Typecode
Default ValueDEV
Fixed ValueDEV
239. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
240. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
241. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.code
Control0..1
BindingThe codes SHALL be taken from EntityCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
242. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SC
Requirements

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

243. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SC
Requirements

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

244. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/MaintainedEntity
245. ClinicalDocument.author.assignedAuthor.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
246. ClinicalDocument.dataEnterer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/DataEnterer
Requirements

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

247. ClinicalDocument.dataEnterer.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
248. ClinicalDocument.dataEnterer.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueENT
249. ClinicalDocument.dataEnterer.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Fixed ValueOP
250. ClinicalDocument.dataEnterer.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
251. ClinicalDocument.dataEnterer.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
252. ClinicalDocument.dataEnterer.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
253. ClinicalDocument.dataEnterer.time
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
254. ClinicalDocument.dataEnterer.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

255. ClinicalDocument.dataEnterer.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
Default ValueASSIGNED
Fixed ValueASSIGNED
256. ClinicalDocument.dataEnterer.assignedEntity.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
257. ClinicalDocument.dataEnterer.assignedEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

258. ClinicalDocument.dataEnterer.assignedEntity.id.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
259. ClinicalDocument.dataEnterer.assignedEntity.id.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring
260. ClinicalDocument.dataEnterer.assignedEntity.id.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
261. 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.

Control0..1
Typestring
Requirements

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

Pattern Value2.16.840.1.113883.4.6
262. ClinicalDocument.dataEnterer.assignedEntity.id.extension
Definition

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

Control0..1
Typestring
263. ClinicalDocument.dataEnterer.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
264. ClinicalDocument.dataEnterer.assignedEntity.code
Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

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

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED)
Requirements

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

InvariantsDefined on this element
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: )
266. ClinicalDocument.dataEnterer.assignedEntity.telecom
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Requirements

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

267. ClinicalDocument.dataEnterer.assignedEntity.telecom.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
268. ClinicalDocument.dataEnterer.assignedEntity.telecom.value
Control0..1
Typeuri
269. ClinicalDocument.dataEnterer.assignedEntity.telecom.useablePeriod
Definition

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

Control0..*
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
270. 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.

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
Typecode
Requirements

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

271. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
Requirements

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

272. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
Default ValuePSN
Fixed ValuePSN
273. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
274. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
275. 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).

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED)
Requirements

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

InvariantsDefined on this element
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). (: )
276. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
277. ClinicalDocument.dataEnterer.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
278. ClinicalDocument.informant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Informant
SlicingThis element introduces a set of slices on ClinicalDocument.informant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ relatedEntity
279. ClinicalDocument.informant:informant1
SliceNameinformant1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Informant
Requirements

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

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
281. ClinicalDocument.informant:informant1.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueINF
282. ClinicalDocument.informant:informant1.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Fixed ValueOP
283. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
284. 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.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
285. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
286. ClinicalDocument.informant:informant1.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

287. ClinicalDocument.informant:informant1.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
Default ValueASSIGNED
Fixed ValueASSIGNED
288. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
289. ClinicalDocument.informant:informant1.assignedEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

InvariantsDefined on this element
1198-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:1198-9946). (: )
290. ClinicalDocument.informant:informant1.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
291. ClinicalDocument.informant:informant1.assignedEntity.code
Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

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

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED)
Requirements

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

InvariantsDefined on this element
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: )
293. ClinicalDocument.informant:informant1.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
294. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
Requirements

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

295. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
Default ValuePSN
Fixed ValuePSN
296. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
297. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
298. 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).

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED)
Requirements

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

InvariantsDefined on this element
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). (: )
299. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
300. ClinicalDocument.informant:informant1.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
301. ClinicalDocument.informant:informant1.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
302. ClinicalDocument.informant:informant2
SliceNameinformant2
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Informant
Requirements

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

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
304. ClinicalDocument.informant:informant2.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueINF
305. ClinicalDocument.informant:informant2.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Fixed ValueOP
306. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
307. 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.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
308. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
309. ClinicalDocument.informant:informant2.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
310. ClinicalDocument.informant:informant2.relatedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
Requirements

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

311. ClinicalDocument.custodian
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Custodian
Requirements

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

312. ClinicalDocument.custodian.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
313. ClinicalDocument.custodian.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueENT
314. ClinicalDocument.custodian.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
315. ClinicalDocument.custodian.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
316. ClinicalDocument.custodian.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
317. ClinicalDocument.custodian.assignedCustodian
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedCustodian
Requirements

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

318. ClinicalDocument.custodian.assignedCustodian.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
Default ValueASSIGNED
Fixed ValueASSIGNED
319. ClinicalDocument.custodian.assignedCustodian.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
320. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CustodianOrganization
Requirements

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

321. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassOrganization
Typecode
Default ValueORG
Fixed ValueORG
322. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
323. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
324. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

325. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
326. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring
327. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
328. 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.

Control0..1
Typestring
Requirements

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

Pattern Value2.16.840.1.113883.4.6
329. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.extension
Definition

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

Control0..1
Typestring
330. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ON
Requirements

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

331. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Requirements

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

332. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
333. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.value
Control0..1
Typeuri
334. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.useablePeriod
Definition

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

Control0..*
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
335. 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.

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
Typecode
Requirements

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

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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED)
Requirements

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

InvariantsDefined on this element
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: )
337. ClinicalDocument.informationRecipient
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/InformationRecipient
Requirements

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

SlicingThis element introduces a set of slices on ClinicalDocument.informationRecipient. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ intendedRecipient
338. ClinicalDocument.informationRecipient.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
339. ClinicalDocument.informationRecipient.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Default ValuePRCP
340. ClinicalDocument.informationRecipient.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
341. ClinicalDocument.informationRecipient.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
342. ClinicalDocument.informationRecipient.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
343. ClinicalDocument.informationRecipient.intendedRecipient
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IntendedRecipient
Requirements

The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:1198-5566).

344. ClinicalDocument.informationRecipient.intendedRecipient.classCode
Control1..1
Typecode
Default ValueASSIGNED
345. ClinicalDocument.informationRecipient.intendedRecipient.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
346. ClinicalDocument.informationRecipient.intendedRecipient.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

This intendedRecipient MAY contain zero or more [0..*] id (CONF:1198-32399).

347. ClinicalDocument.informationRecipient.intendedRecipient.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
348. ClinicalDocument.informationRecipient.intendedRecipient.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
349. ClinicalDocument.informationRecipient.intendedRecipient.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
350. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
Requirements

This intendedRecipient MAY contain zero or one [0..1] informationRecipient (CONF:1198-5567).

351. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
Default ValuePSN
Fixed ValuePSN
352. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
353. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
354. 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).

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED)
Requirements

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

InvariantsDefined on this element
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). (: )
355. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
356. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
Requirements

This intendedRecipient MAY contain zero or one [0..1] receivedOrganization (CONF:1198-5577).

357. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassOrganization
Typecode
Default ValueORG
Fixed ValueORG
358. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
359. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
360. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
361. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ON
Requirements

The receivedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:1198-5578).

362. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
363. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
364. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCode
Control0..1
BindingThe codes SHALL be taken from OrganizationIndustryClassNAICS; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
365. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/OrganizationPartOf
366. ClinicalDocument.informationRecipient:informationRecipient1
SliceNameinformationRecipient1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/InformationRecipient
Requirements

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

367. ClinicalDocument.informationRecipient:informationRecipient1.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
368. ClinicalDocument.informationRecipient:informationRecipient1.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Default ValuePRCP
369. ClinicalDocument.informationRecipient:informationRecipient1.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
370. ClinicalDocument.informationRecipient:informationRecipient1.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
371. ClinicalDocument.informationRecipient:informationRecipient1.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
372. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IntendedRecipient
Requirements

SHALL contain exactly one [1..1] intendedRecipient (CONF:1198-31994).

373. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.classCode
Control1..1
Typecode
Default ValueASSIGNED
374. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
375. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

376. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
377. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
Requirements

This intendedRecipient SHOULD contain zero or more [0..*] addr (CONF:1198-31997).

378. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Requirements

This intendedRecipient SHOULD contain zero or more [0..*] telecom (CONF:1198-31998).

379. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.informationRecipient
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
Requirements

This intendedRecipient SHOULD contain zero or one [0..1] informationRecipient (CONF:1198-31999).

380. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.informationRecipient.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
Default ValuePSN
Fixed ValuePSN
381. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.informationRecipient.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
382. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.informationRecipient.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
383. ClinicalDocument.informationRecipient:informationRecipient1.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).

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED)
Requirements

The informationRecipient, if present, SHALL contain exactly one [1..1] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-32320).

InvariantsDefined on this element
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). (: )
384. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.informationRecipient.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
385. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
Requirements

This intendedRecipient SHOULD contain zero or one [0..1] receivedOrganization (CONF:1198-32000).

386. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassOrganization
Typecode
Default ValueORG
Fixed ValueORG
387. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
388. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
389. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

The receivedOrganization, if present, SHOULD contain zero or more [0..*] id (CONF:1198-32001).

390. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.name
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ON
Requirements

The receivedOrganization, if present, SHALL contain at least one [1..*] name (CONF:1198-32002).

391. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
392. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
393. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.standardIndustryClassCode
Control0..1
BindingThe codes SHALL be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

The receivedOrganization, if present, SHOULD contain zero or one [0..1] standardIndustryClassCode, which SHALL be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-32003).

394. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.asOrganizationPartOf
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/OrganizationPartOf
395. ClinicalDocument.legalAuthenticator
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/LegalAuthenticator
Requirements

SHOULD contain zero or one [0..1] legalAuthenticator (CONF:1198-5579).

396. ClinicalDocument.legalAuthenticator.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
397. ClinicalDocument.legalAuthenticator.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueLA
398. ClinicalDocument.legalAuthenticator.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Fixed ValueOP
399. ClinicalDocument.legalAuthenticator.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
400. ClinicalDocument.legalAuthenticator.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
401. ClinicalDocument.legalAuthenticator.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
402. 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.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS(USRealmDateandTimeDTMUSFIELDED)
Requirements

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

InvariantsDefined on this element
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). (: )
403. ClinicalDocument.legalAuthenticator.signatureCode
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

The legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:1198-5583).

404. ClinicalDocument.legalAuthenticator.signatureCode.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
405. 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.

Control1..1
Typestring
Requirements

This signatureCode SHALL contain exactly one [1..1] @code="S" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:1198-5584).

Pattern ValueS
406. ClinicalDocument.legalAuthenticator.signatureCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
407. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
408. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemVersion
Definition

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

Control0..0
Typestring
409. ClinicalDocument.legalAuthenticator.signatureCode.displayName
Definition

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

Control0..0
Typestring
410. ClinicalDocument.legalAuthenticator.signatureCode.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
411. ClinicalDocument.legalAuthenticator.signatureCode.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
412. ClinicalDocument.legalAuthenticator.signatureCode.originalText
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
413. ClinicalDocument.legalAuthenticator.signatureCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
414. ClinicalDocument.legalAuthenticator.signatureCode.translation
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
415. ClinicalDocument.legalAuthenticator.sdtcSignatureText
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
416. ClinicalDocument.legalAuthenticator.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

417. ClinicalDocument.legalAuthenticator.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
Default ValueASSIGNED
Fixed ValueASSIGNED
418. ClinicalDocument.legalAuthenticator.assignedEntity.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
419. ClinicalDocument.legalAuthenticator.assignedEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

420. ClinicalDocument.legalAuthenticator.assignedEntity.id.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
421. ClinicalDocument.legalAuthenticator.assignedEntity.id.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring
422. ClinicalDocument.legalAuthenticator.assignedEntity.id.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
423. 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.

Control0..1
Typestring
Requirements

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

Pattern Value2.16.840.1.113883.4.6
424. ClinicalDocument.legalAuthenticator.assignedEntity.id.extension
Definition

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

Control0..1
Typestring
425. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
426. ClinicalDocument.legalAuthenticator.assignedEntity.code
Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

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

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED)
Requirements

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

InvariantsDefined on this element
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: )
428. ClinicalDocument.legalAuthenticator.assignedEntity.telecom
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Requirements

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

429. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
430. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.value
Control0..1
Typeuri
431. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.useablePeriod
Definition

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

Control0..*
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
432. 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.

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
Typecode
Requirements

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

433. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
Requirements

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

434. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
Default ValuePSN
Fixed ValuePSN
435. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
436. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
437. 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).

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED)
Requirements

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

InvariantsDefined on this element
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). (: )
438. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
439. ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
440. ClinicalDocument.authenticator
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Authenticator
SlicingThis element introduces a set of slices on ClinicalDocument.authenticator. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ signatureCode
  • ,
  • value @ assignedEntity
441. ClinicalDocument.authenticator:authenticator1
SliceNameauthenticator1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Authenticator
Requirements

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

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
443. ClinicalDocument.authenticator:authenticator1.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueAUTHEN
444. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
445. 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.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
446. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
447. 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.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS(USRealmDateandTimeDTMUSFIELDED)
Requirements

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

InvariantsDefined on this element
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). (: )
448. ClinicalDocument.authenticator:authenticator1.signatureCode
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

SHALL contain exactly one [1..1] signatureCode (CONF:1198-5610).

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
450. 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.

Control1..1
Typestring
Requirements

This signatureCode SHALL contain exactly one [1..1] @code="S" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:1198-5611).

Pattern ValueS
451. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
452. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
453. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemVersion
Definition

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

Control0..0
Typestring
454. 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.

Control0..0
Typestring
455. 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.

Control0..1
Typestring
456. 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.

Control0..1
Typestring
457. ClinicalDocument.authenticator:authenticator1.signatureCode.originalText
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
458. ClinicalDocument.authenticator:authenticator1.signatureCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
459. ClinicalDocument.authenticator:authenticator1.signatureCode.translation
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
460. ClinicalDocument.authenticator:authenticator1.sdtcSignatureText
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
461. ClinicalDocument.authenticator:authenticator1.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

462. ClinicalDocument.authenticator:authenticator1.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
Default ValueASSIGNED
Fixed ValueASSIGNED
463. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
464. ClinicalDocument.authenticator:authenticator1.assignedEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
466. 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.

Control0..1
Typestring
467. 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).

Control0..1
Typeboolean
468. 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.

Control0..1
Typestring
Requirements

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

Pattern Value2.16.840.1.113883.4.6
469. ClinicalDocument.authenticator:authenticator1.assignedEntity.id.extension
Definition

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

Control0..1
Typestring
470. ClinicalDocument.authenticator:authenticator1.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
471. ClinicalDocument.authenticator:authenticator1.assignedEntity.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
473. 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.

Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typestring
Requirements

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

474. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
475. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
476. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codeSystemVersion
Definition

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

Control0..1
Typestring
477. 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.

Control0..1
Typestring
478. 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.

Control0..1
Typestring
479. 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.

Control0..1
Typestring
480. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
481. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
482. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.translation
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
483. 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.

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED)
Requirements

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

InvariantsDefined on this element
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: )
484. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Requirements

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

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
486. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.value
Control0..1
Typeuri
487. 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.

Control0..*
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
488. 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.

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
Typecode
Requirements

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

489. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
Requirements

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

490. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
Default ValuePSN
Fixed ValuePSN
491. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
492. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
493. 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).

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED)
Requirements

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

InvariantsDefined on this element
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). (: )
494. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
495. ClinicalDocument.authenticator:authenticator1.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
496. ClinicalDocument.authenticator:authenticator2
SliceNameauthenticator2
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Authenticator
Requirements

SHOULD contain zero or one [0..1] authenticator (CONF:1198-31910) such that it

497. ClinicalDocument.authenticator:authenticator2.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
498. ClinicalDocument.authenticator:authenticator2.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueAUTHEN
499. ClinicalDocument.authenticator:authenticator2.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
500. ClinicalDocument.authenticator:authenticator2.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
501. ClinicalDocument.authenticator:authenticator2.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
502. ClinicalDocument.authenticator:authenticator2.time
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Requirements

SHALL contain exactly one [1..1] time (CONF:1198-31911).

503. ClinicalDocument.authenticator:authenticator2.signatureCode
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

SHALL contain exactly one [1..1] signatureCode (CONF:1198-31912).

504. ClinicalDocument.authenticator:authenticator2.sdtcSignatureText
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
505. ClinicalDocument.authenticator:authenticator2.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

506. ClinicalDocument.authenticator:authenticator2.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
Default ValueASSIGNED
Fixed ValueASSIGNED
507. ClinicalDocument.authenticator:authenticator2.assignedEntity.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
508. ClinicalDocument.authenticator:authenticator2.assignedEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

509. ClinicalDocument.authenticator:authenticator2.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
510. ClinicalDocument.authenticator:authenticator2.assignedEntity.code
Control1..1
BindingThe codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

This assignedEntity SHALL contain exactly one [1..1] code (CONF:1198-31916).

511. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
512. ClinicalDocument.authenticator:authenticator2.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.

Control1..1
Typestring
Requirements

This code SHALL contain exactly one [1..1] @code="ONESELF" Self (CONF:1198-31917).

Pattern ValueONESELF
513. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.codeSystem
Definition

Specifies the code system that defines the code.

Control1..1
Typestring
Requirements

This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.5.111" (CodeSystem: HL7RoleCode urn:oid:2.16.840.1.113883.5.111) (CONF:1198-31918).

Pattern Value2.16.840.1.113883.5.111
514. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
515. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.codeSystemVersion
Definition

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

Control0..1
Typestring
516. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.displayName
Definition

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

Control0..1
Typestring
517. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
518. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
519. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
520. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
521. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.translation
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
522. ClinicalDocument.authenticator:authenticator2.assignedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
523. ClinicalDocument.authenticator:authenticator2.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
524. ClinicalDocument.authenticator:authenticator2.assignedEntity.assignedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
525. ClinicalDocument.authenticator:authenticator2.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
526. ClinicalDocument.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant1
SlicingThis element introduces a set of slices on ClinicalDocument.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
527. ClinicalDocument.participant:participant1
SliceNameparticipant1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant1
Requirements

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

InvariantsDefined on this element
1198-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:1198-10006). (: )
1198-10007: When participant/@typeCode is *IND*, associatedEntity/@classCode **SHOULD** be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *STATIC 2011-09-30* (CONF:1198-10007). (: )
528. ClinicalDocument.participant:participant1.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
529. ClinicalDocument.participant:participant1.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode="VRF" Verifier (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:1198-31678).

Pattern ValueVRF
530. ClinicalDocument.participant:participant1.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Fixed ValueOP
531. ClinicalDocument.participant:participant1.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
532. ClinicalDocument.participant:participant1.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
533. ClinicalDocument.participant:participant1.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
534. ClinicalDocument.participant:participant1.functionCode
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

SHALL contain exactly one [1..1] functionCode (CONF:1198-31679).

535. ClinicalDocument.participant:participant1.functionCode.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
536. ClinicalDocument.participant:participant1.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.

Control1..1
Typestring
Requirements

This functionCode SHALL contain exactly one [1..1] @code="425268008" Review of Care Plan (CONF:1198-31680).

Pattern Value425268008
537. ClinicalDocument.participant:participant1.functionCode.codeSystem
Definition

Specifies the code system that defines the code.

Control1..1
Typestring
Requirements

This functionCode SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.96" (CodeSystem: SNOMED CT urn:oid:2.16.840.1.113883.6.96) (CONF:1198-31681).

Pattern Value2.16.840.1.113883.6.96
538. ClinicalDocument.participant:participant1.functionCode.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
539. ClinicalDocument.participant:participant1.functionCode.codeSystemVersion
Definition

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

Control0..1
Typestring
540. ClinicalDocument.participant:participant1.functionCode.displayName
Definition

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

Control0..1
Typestring
541. ClinicalDocument.participant:participant1.functionCode.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
542. ClinicalDocument.participant:participant1.functionCode.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
543. ClinicalDocument.participant:participant1.functionCode.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
544. ClinicalDocument.participant:participant1.functionCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
545. ClinicalDocument.participant:participant1.functionCode.translation
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
546. ClinicalDocument.participant:participant1.time
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

SHALL contain exactly one [1..1] time (CONF:1198-31682).

547. ClinicalDocument.participant:participant1.associatedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssociatedEntity
Requirements

SHALL contain exactly one [1..1] associatedEntity (CONF:1198-31683).

548. ClinicalDocument.participant:participant1.associatedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssociative
Typecode
Requirements

This associatedEntity SHALL contain exactly one [1..1] @classCode="ASSIGNED" (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110) (CONF:1198-31686).

Pattern ValueASSIGNED
549. ClinicalDocument.participant:participant1.associatedEntity.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
550. ClinicalDocument.participant:participant1.associatedEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

551. ClinicalDocument.participant:participant1.associatedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
552. ClinicalDocument.participant:participant1.associatedEntity.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

553. ClinicalDocument.participant:participant1.associatedEntity.code.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
554. ClinicalDocument.participant:participant1.associatedEntity.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.

Control1..1
BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type
Typestring
Requirements

The code, if present, SHALL contain exactly one [1..1] @code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-32367).

555. ClinicalDocument.participant:participant1.associatedEntity.code.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
556. ClinicalDocument.participant:participant1.associatedEntity.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
557. ClinicalDocument.participant:participant1.associatedEntity.code.codeSystemVersion
Definition

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

Control0..1
Typestring
558. ClinicalDocument.participant:participant1.associatedEntity.code.displayName
Definition

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

Control0..1
Typestring
559. ClinicalDocument.participant:participant1.associatedEntity.code.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
560. ClinicalDocument.participant:participant1.associatedEntity.code.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
561. ClinicalDocument.participant:participant1.associatedEntity.code.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
562. ClinicalDocument.participant:participant1.associatedEntity.code.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
563. ClinicalDocument.participant:participant1.associatedEntity.code.translation
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
564. ClinicalDocument.participant:participant1.associatedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
565. ClinicalDocument.participant:participant1.associatedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
566. ClinicalDocument.participant:participant1.associatedEntity.associatedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
567. ClinicalDocument.participant:participant1.associatedEntity.scopingOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
568. ClinicalDocument.participant:participant2
SliceNameparticipant2
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant1
Requirements

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

569. ClinicalDocument.participant:participant2.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
570. ClinicalDocument.participant:participant2.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode="IND" Indirect (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:1198-31896).

Pattern ValueIND
571. ClinicalDocument.participant:participant2.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Fixed ValueOP
572. ClinicalDocument.participant:participant2.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
573. ClinicalDocument.participant:participant2.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
574. ClinicalDocument.participant:participant2.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
575. ClinicalDocument.participant:participant2.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
576. ClinicalDocument.participant:participant2.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
577. ClinicalDocument.participant:participant2.associatedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssociatedEntity
Requirements

SHALL contain exactly one [1..1] associatedEntity (CONF:1198-31897).

578. ClinicalDocument.participant:participant2.associatedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from INDRoleclassCodes
Typecode
Requirements

This associatedEntity SHALL contain exactly one [1..1] @classCode, which SHALL be selected from ValueSet INDRoleclassCodes urn:oid:2.16.840.1.113883.11.20.9.33 STATIC (CONF:1198-31898).

579. ClinicalDocument.participant:participant2.associatedEntity.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
580. ClinicalDocument.participant:participant2.associatedEntity.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
581. ClinicalDocument.participant:participant2.associatedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
582. ClinicalDocument.participant:participant2.associatedEntity.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
583. ClinicalDocument.participant:participant2.associatedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
584. ClinicalDocument.participant:participant2.associatedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
585. ClinicalDocument.participant:participant2.associatedEntity.associatedPerson
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
Requirements

This associatedEntity SHALL contain exactly one [1..1] associatedPerson (CONF:1198-31899).

586. ClinicalDocument.participant:participant2.associatedEntity.associatedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
Default ValuePSN
Fixed ValuePSN
587. ClinicalDocument.participant:participant2.associatedEntity.associatedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
588. ClinicalDocument.participant:participant2.associatedEntity.associatedPerson.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
589. ClinicalDocument.participant:participant2.associatedEntity.associatedPerson.name
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/EN
Requirements

This associatedPerson SHALL contain at least one [1..*] name (CONF:1198-31900).

590. ClinicalDocument.participant:participant2.associatedEntity.associatedPerson.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
591. ClinicalDocument.participant:participant2.associatedEntity.scopingOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
592. ClinicalDocument.inFulfillmentOf
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/InFulfillmentOf
Requirements

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

593. ClinicalDocument.inFulfillmentOf.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
594. ClinicalDocument.inFulfillmentOf.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueFLFS
595. ClinicalDocument.inFulfillmentOf.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
596. ClinicalDocument.inFulfillmentOf.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
597. ClinicalDocument.inFulfillmentOf.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
598. ClinicalDocument.inFulfillmentOf.order
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Order
Requirements

The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:1198-9953).

599. ClinicalDocument.inFulfillmentOf.order.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
Default ValueACT
600. ClinicalDocument.inFulfillmentOf.order.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMoodIntent
Typecode
Default ValueRQO
Fixed ValueRQO
601. ClinicalDocument.inFulfillmentOf.order.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
602. ClinicalDocument.inFulfillmentOf.order.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

603. ClinicalDocument.inFulfillmentOf.order.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System ActCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
604. ClinicalDocument.inFulfillmentOf.order.priorityCode
Control0..1
BindingThe codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
605. ClinicalDocument.documentationOf
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/DocumentationOf
Requirements

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

SlicingThis element introduces a set of slices on ClinicalDocument.documentationOf. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ serviceEvent
606. ClinicalDocument.documentationOf.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
607. ClinicalDocument.documentationOf.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueDOC
608. ClinicalDocument.documentationOf.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
609. ClinicalDocument.documentationOf.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
610. ClinicalDocument.documentationOf.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
611. ClinicalDocument.documentationOf.serviceEvent
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ServiceEvent
Requirements

The documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:1198-14836).

612. ClinicalDocument.documentationOf.serviceEvent.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
Default ValueACT
613. ClinicalDocument.documentationOf.serviceEvent.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
Default ValueEVN
Fixed ValueEVN
614. ClinicalDocument.documentationOf.serviceEvent.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
615. ClinicalDocument.documentationOf.serviceEvent.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
616. ClinicalDocument.documentationOf.serviceEvent.code
Definition

Drawn from concept domain ActCode

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
617. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

This serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:1198-14837).

618. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
619. 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.

Control0..1
TypedateTime
620. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.inclusive
Definition

Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).

Control0..1
Typeboolean
621. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.operator
Definition

A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.

Control0..1
Typecode
622. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low
Definition

This is the low limit of the interval.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Requirements

This effectiveTime SHALL contain exactly one [1..1] low (CONF:1198-14838).

623. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
Definition

This is the high limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
624. 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.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
625. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.center
Definition

The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
626. ClinicalDocument.documentationOf.serviceEvent.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer1
Requirements

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

627. ClinicalDocument.documentationOf.serviceEvent.performer.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
628. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode
Control1..1
BindingThe codes SHALL be taken from x_ServiceEventPerformer
Typecode
Requirements

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

Fixed ValueDOC
629. ClinicalDocument.documentationOf.serviceEvent.performer.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
630. ClinicalDocument.documentationOf.serviceEvent.performer.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
631. ClinicalDocument.documentationOf.serviceEvent.performer.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
632. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:1198-16818).

633. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
634. 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.

Control0..1
BindingThe codes SHOULD be taken from Care Team Member Function
Typestring
Requirements

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

635. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
636. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
637. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemVersion
Definition

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

Control0..1
Typestring
638. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.displayName
Definition

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

Control0..1
Typestring
639. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
640. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
641. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
642. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
643. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.translation
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
644. ClinicalDocument.documentationOf.serviceEvent.performer.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
645. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

646. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
Default ValueASSIGNED
Fixed ValueASSIGNED
647. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
648. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

649. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
650. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring
651. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
652. 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.

Control0..1
Typestring
Requirements

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

Pattern Value2.16.840.1.113883.4.6
653. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.extension
Definition

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

Control0..1
Typestring
654. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
655. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code
Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

656. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
657. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
658. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
659. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
660. ClinicalDocument.documentationOf:documentationOf1
SliceNamedocumentationOf1
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/DocumentationOf
Requirements

SHALL contain exactly one [1..1] documentationOf (CONF:1198-31901) such that it

661. ClinicalDocument.documentationOf:documentationOf1.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
662. ClinicalDocument.documentationOf:documentationOf1.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueDOC
663. ClinicalDocument.documentationOf:documentationOf1.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
664. ClinicalDocument.documentationOf:documentationOf1.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
665. ClinicalDocument.documentationOf:documentationOf1.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
666. ClinicalDocument.documentationOf:documentationOf1.serviceEvent
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ServiceEvent
Requirements

SHALL contain exactly one [1..1] serviceEvent (CONF:1198-31902).

667. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
Requirements

This serviceEvent SHALL contain exactly one [1..1] @classCode="PCPR" Care Provision (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1198-31903).

Default ValueACT
Pattern ValuePCPR
668. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
Default ValueEVN
Fixed ValueEVN
669. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
670. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
671. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.code
Definition

Drawn from concept domain ActCode

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
672. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

This serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:1198-31904).

673. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
674. ClinicalDocument.documentationOf:documentationOf1.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.

Control0..1
TypedateTime
675. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime.inclusive
Definition

Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).

Control0..1
Typeboolean
676. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime.operator
Definition

A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.

Control0..1
Typecode
677. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime.low
Definition

This is the low limit of the interval.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Requirements

This effectiveTime SHALL contain exactly one [1..1] low (CONF:1198-32330).

678. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime.high
Definition

This is the high limit of the interval.

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

This effectiveTime MAY contain zero or one [0..1] high (CONF:1198-32331).

679. ClinicalDocument.documentationOf:documentationOf1.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.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
680. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime.center
Definition

The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
681. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer1
Requirements

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

SlicingThis element introduces a set of slices on ClinicalDocument.documentationOf.serviceEvent.performer. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ assignedEntity
682. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
683. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.typeCode
Control1..1
BindingThe codes SHALL be taken from x_ServiceEventPerformer
Typecode
Requirements

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

Fixed ValueDOC
684. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
685. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
686. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
687. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:1198-16818).

688. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
689. ClinicalDocument.documentationOf:documentationOf1.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.

Control0..1
BindingThe codes SHOULD be taken from Care Team Member Function
Typestring
Requirements

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

690. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
691. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
692. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.codeSystemVersion
Definition

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

Control0..1
Typestring
693. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.displayName
Definition

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

Control0..1
Typestring
694. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
695. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
696. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
697. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
698. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.translation
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
699. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
700. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

701. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
Default ValueASSIGNED
Fixed ValueASSIGNED
702. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
703. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

704. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.id.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
705. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.id.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring
706. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.id.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
707. ClinicalDocument.documentationOf:documentationOf1.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.

Control0..1
Typestring
Requirements

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

Pattern Value2.16.840.1.113883.4.6
708. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.id.extension
Definition

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

Control0..1
Typestring
709. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
710. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.code
Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

711. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
712. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
713. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.assignedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
714. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
715. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1
SliceNameperformer1
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer1
Requirements

This serviceEvent SHALL contain at least one [1..*] performer (CONF:1198-31905) such that it

716. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
717. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.typeCode
Control1..1
BindingThe codes SHALL be taken from x_ServiceEventPerformer
Typecode
Requirements

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

Fixed ValueDOC
718. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
719. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
720. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
721. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:1198-16818).

722. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
723. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.code
Definition

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

Control0..1
BindingThe codes SHOULD be taken from Care Team Member Function
Typestring
Requirements

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

724. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
725. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
726. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.codeSystemVersion
Definition

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

Control0..1
Typestring
727. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.displayName
Definition

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

Control0..1
Typestring
728. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
729. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
730. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
731. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
732. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.translation
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
733. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
734. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

735. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
Default ValueASSIGNED
Fixed ValueASSIGNED
736. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
737. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

738. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.id.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
739. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.id.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring
740. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.id.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
741. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.id.root
Definition

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

Control0..1
Typestring
Requirements

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

Pattern Value2.16.840.1.113883.4.6
742. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.id.extension
Definition

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

Control0..1
Typestring
743. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
744. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.code
Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

745. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
746. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
747. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.assignedPerson
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
Requirements

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

748. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.assignedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
Default ValuePSN
Fixed ValuePSN
749. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.assignedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
750. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.assignedPerson.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
751. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.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).

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED)
Requirements

This assignedPerson SHALL contain exactly one [1..1] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-32329).

InvariantsDefined on this element
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). (: )
752. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
753. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
754. ClinicalDocument.relatedDocument
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedDocument
SlicingThis element introduces a set of slices on ClinicalDocument.relatedDocument. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ parentDocument
  • ,
  • value @ typeCode
755. ClinicalDocument.relatedDocument:relatedDocument1
SliceNamerelatedDocument1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedDocument
Requirements

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

756. ClinicalDocument.relatedDocument:relatedDocument1.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
757. ClinicalDocument.relatedDocument:relatedDocument1.typeCode
Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipDocument
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode, which SHALL be selected from ValueSet x_ActRelationshipDocument urn:oid:2.16.840.1.113883.1.11.11610 STATIC (CONF:1198-31889).

758. ClinicalDocument.relatedDocument:relatedDocument1.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
759. ClinicalDocument.relatedDocument:relatedDocument1.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
760. ClinicalDocument.relatedDocument:relatedDocument1.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
761. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParentDocument
Requirements

SHALL contain exactly one [1..1] parentDocument (CONF:1198-29894).

762. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.classCode
Control1..1
BindingThe codes SHALL be taken from ActClassClinicalDocument
Typecode
Default ValueDOCCLIN
Fixed ValueDOCCLIN
763. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
Default ValueEVN
Fixed ValueEVN
764. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
765. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

766. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.code
Control0..1
BindingThe codes SHALL be taken from http://terminology.hl7.org/ValueSet/v3-DocumentType; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
767. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
768. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.setId
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

This parentDocument SHALL contain exactly one [1..1] setId (CONF:1198-29895).

769. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.versionNumber
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
Requirements

This parentDocument SHALL contain exactly one [1..1] versionNumber (CONF:1198-29896).

770. ClinicalDocument.authorization
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Authorization
SlicingThis element introduces a set of slices on ClinicalDocument.authorization. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ consent
771. ClinicalDocument.authorization:authorization1
SliceNameauthorization1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Authorization
Requirements

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

772. ClinicalDocument.authorization:authorization1.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
773. ClinicalDocument.authorization:authorization1.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueAUT
774. ClinicalDocument.authorization:authorization1.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
775. ClinicalDocument.authorization:authorization1.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
776. ClinicalDocument.authorization:authorization1.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
777. ClinicalDocument.authorization:authorization1.consent
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Consent
Requirements

SHALL contain exactly one [1..1] consent (CONF:1198-16793).

778. ClinicalDocument.authorization:authorization1.consent.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
Default ValueCONS
Fixed ValueCONS
779. ClinicalDocument.authorization:authorization1.consent.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
Default ValueEVN
Fixed ValueEVN
780. ClinicalDocument.authorization:authorization1.consent.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
781. ClinicalDocument.authorization:authorization1.consent.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

This consent MAY contain zero or more [0..*] id (CONF:1198-16794).

782. ClinicalDocument.authorization:authorization1.consent.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System ActCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

783. ClinicalDocument.authorization:authorization1.consent.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

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

784. ClinicalDocument.authorization:authorization1.consent.statusCode.code
Control1..1
Requirements

This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1198-16798).

Default Valuecompleted
Fixed Valuecompleted
785. ClinicalDocument.componentOf:componentOf1
SliceNamecomponentOf1
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ComponentOf
Requirements

SHOULD contain zero or one [0..1] componentOf (CONF:1198-32004) such that it

786. ClinicalDocument.componentOf:componentOf1.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
787. ClinicalDocument.componentOf:componentOf1.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueAUT
788. ClinicalDocument.componentOf:componentOf1.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
789. ClinicalDocument.componentOf:componentOf1.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
790. ClinicalDocument.componentOf:componentOf1.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
791. ClinicalDocument.componentOf:componentOf1.encompassingEncounter
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/EncompassingEncounter
Requirements

SHALL contain exactly one [1..1] encompassingEncounter (CONF:1198-32005).

792. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
Default ValueENC
Fixed ValueENC
793. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
Default ValueEVN
Fixed ValueEVN
794. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
795. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

796. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.code
Control0..1
BindingThe codes SHALL be taken from ActEncounterCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
797. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

This encompassingEncounter SHALL contain exactly one [1..1] effectiveTime (CONF:1198-32007).

798. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.sdtcAdmissionReferralSourceCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
799. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.dischargeDispositionCode
Control0..1
BindingThe codes SHALL be taken from http://terminology.hl7.org/ValueSet/v3-EncounterDischargeDisposition; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
800. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.responsibleParty
Control0..1
TypeElement
801. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.responsibleParty.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Default ValueRESP
Fixed ValueRESP
802. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.responsibleParty.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
803. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.encounterParticipant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/EncounterParticipant
804. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.location
Control0..1
TypeElement
805. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.location.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetLocation
Typecode
Default ValueLOC
Fixed ValueLOC
806. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.location.healthCareFacility
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/HealthCareFacility
807. ClinicalDocument.component
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Component2
Requirements

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

808. ClinicalDocument.component.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
809. ClinicalDocument.component.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueAUT
810. ClinicalDocument.component.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
811. ClinicalDocument.component.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
812. ClinicalDocument.component.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
813. ClinicalDocument.component.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
814. ClinicalDocument.component.nonXMLBody
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/NonXMLBody
815. ClinicalDocument.component.structuredBody
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/StructuredBody
Requirements

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

InvariantsDefined on this element
1198-31044: This structuredBody **SHALL NOT** contain a Plan of Treatment Section (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.10:2014-06-09) (CONF:1198-31044). (: )
816. ClinicalDocument.component.structuredBody.classCode
Control1..1
BindingThe codes SHALL be taken from http://terminology.hl7.org/ValueSet/v3-ActClassOrganizer
Typecode
Default ValueDOCBODY
Fixed ValueDOCBODY
817. ClinicalDocument.component.structuredBody.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
Default ValueEVN
Fixed ValueEVN
818. ClinicalDocument.component.structuredBody.confidentialityCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
819. ClinicalDocument.component.structuredBody.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
820. ClinicalDocument.component.structuredBody.component
Control1..*
TypeElement
SlicingThis element introduces a set of slices on ClinicalDocument.component.structuredBody.component. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ ClinicalDocument.section
821. ClinicalDocument.component.structuredBody.component.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
822. ClinicalDocument.component.structuredBody.component.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
823. ClinicalDocument.component.structuredBody.component.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section
824. ClinicalDocument.component.structuredBody.component:component1
SliceNamecomponent1
Control1..1
TypeElement
Requirements

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

825. ClinicalDocument.component.structuredBody.component:component1.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
826. ClinicalDocument.component.structuredBody.component:component1.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
827. ClinicalDocument.component.structuredBody.component:component1.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(HealthConcernsSection)
Requirements

This component SHALL contain exactly one [1..1] Health Concerns Section (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.58:2015-08-01) (CONF:1198-28756).

828. ClinicalDocument.component.structuredBody.component:component2
SliceNamecomponent2
Control1..1
TypeElement
Requirements

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

829. ClinicalDocument.component.structuredBody.component:component2.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
830. ClinicalDocument.component.structuredBody.component:component2.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
831. ClinicalDocument.component.structuredBody.component:component2.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(GoalsSection)
Requirements

SHALL contain exactly one [1..1] Goals Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.60) (CONF:1198-28762).

832. ClinicalDocument.component.structuredBody.component:component3
SliceNamecomponent3
Control0..1
TypeElement
Requirements

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

833. ClinicalDocument.component.structuredBody.component:component3.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
834. ClinicalDocument.component.structuredBody.component:component3.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
835. ClinicalDocument.component.structuredBody.component:component3.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(InterventionsSection)
Requirements

SHALL contain exactly one [1..1] Interventions Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.21.2.3:2015-08-01) (CONF:1198-28764).

836. ClinicalDocument.component.structuredBody.component:component4
SliceNamecomponent4
Control0..1
TypeElement
Requirements

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

837. ClinicalDocument.component.structuredBody.component:component4.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
838. ClinicalDocument.component.structuredBody.component:component4.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
839. ClinicalDocument.component.structuredBody.component:component4.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(HealthStatusEvaluationsandOutcomesSection)
Requirements

SHALL contain exactly one [1..1] Health Status Evaluations and Outcomes Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.61) (CONF:1198-29597).