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

Active as of 2022-05-13

Definitions for the 2.16.840.1.113883.10.20.22.1.9 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-7588) such that it

InvariantsDefined on this element
1198-32942: 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-32942). (: )
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.9" (CONF:1198-10052).

Pattern Value2.16.840.1.113883.10.20.22.1.9
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-32521).

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

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 http://hl7.org/fhir/ccda/ValueSet/2.16.840.1.113883.11.20.8.1
Typestring
Requirements

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

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

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

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

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

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

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.legalAuthenticator
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/LegalAuthenticator
Requirements

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

367. 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
368. ClinicalDocument.legalAuthenticator.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueLA
369. ClinicalDocument.legalAuthenticator.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Fixed ValueOP
370. 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
371. 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
372. 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
373. 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). (: )
374. 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).

375. 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
376. 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
377. ClinicalDocument.legalAuthenticator.signatureCode.codeSystem
Definition

Specifies the code system that defines the code.

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

The common name of the coding system.

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

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

Control0..0
Typestring
380. 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
381. 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
382. 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
383. 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
384. 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
385. 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
386. ClinicalDocument.legalAuthenticator.sdtcSignatureText
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
387. 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).

388. ClinicalDocument.legalAuthenticator.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
Default ValueASSIGNED
Fixed ValueASSIGNED
389. 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
390. 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).

391. 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
392. 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
393. 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
394. 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
395. ClinicalDocument.legalAuthenticator.assignedEntity.id.extension
Definition

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

Control0..1
Typestring
396. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
397. 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).

398. 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). (: )
399. 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).

400. 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
401. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.value
Control0..1
Typeuri
402. 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
403. 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).

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

405. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
Default ValuePSN
Fixed ValuePSN
406. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
407. 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
408. 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). (: )
409. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
410. ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
411. 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
412. 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

413. 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
414. ClinicalDocument.authenticator:authenticator1.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueAUTHEN
415. 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
416. 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
417. 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
418. 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). (: )
419. ClinicalDocument.authenticator:authenticator1.signatureCode
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

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

420. 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
421. 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
422. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystem
Definition

Specifies the code system that defines the code.

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

The common name of the coding system.

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

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

Control0..0
Typestring
425. 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
426. 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
427. 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
428. 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
429. 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
430. 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
431. ClinicalDocument.authenticator:authenticator1.sdtcSignatureText
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
432. ClinicalDocument.authenticator:authenticator1.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

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

436. 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
437. 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
438. 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
439. 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
440. ClinicalDocument.authenticator:authenticator1.assignedEntity.id.extension
Definition

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

Control0..1
Typestring
441. ClinicalDocument.authenticator:authenticator1.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
442. 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).

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

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

Specifies the code system that defines the code.

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

The common name of the coding system.

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

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

Control0..1
Typestring
448. 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
449. 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
450. 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
451. 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
452. 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
453. 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
454. 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). (: )
455. 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).

456. 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
457. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.value
Control0..1
Typeuri
458. 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
459. 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).

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

461. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
Default ValuePSN
Fixed ValuePSN
462. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
463. 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
464. 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). (: )
465. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
466. ClinicalDocument.authenticator:authenticator1.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
467. 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 defines no discriminators to differentiate the slices
468. ClinicalDocument.participant:participant1
SliceNameparticipant1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant1
Requirements

MAY contain zero or more [0..*] participant (CONF:1198-10003) 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). (: )
469. 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
470. ClinicalDocument.participant:participant1.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
471. ClinicalDocument.participant:participant1.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Fixed ValueOP
472. 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
473. 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
474. 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
475. ClinicalDocument.participant:participant1.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
476. ClinicalDocument.participant:participant1.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

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

477. ClinicalDocument.participant:participant1.associatedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssociatedEntity
478. ClinicalDocument.inFulfillmentOf
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/InFulfillmentOf
Requirements

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

479. 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
480. ClinicalDocument.inFulfillmentOf.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueFLFS
481. 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
482. 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
483. 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
484. 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).

485. ClinicalDocument.inFulfillmentOf.order.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
Default ValueACT
486. ClinicalDocument.inFulfillmentOf.order.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMoodIntent
Typecode
Default ValueRQO
Fixed ValueRQO
487. 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
488. 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).

489. 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
490. 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
491. ClinicalDocument.documentationOf
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/DocumentationOf
Requirements

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

492. 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
493. ClinicalDocument.documentationOf.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueDOC
494. 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
495. 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
496. 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
497. 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-7604).

498. ClinicalDocument.documentationOf.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 STATIC) (CONF:1198-26420).

Default ValueACT
Pattern ValuePCPR
499. ClinicalDocument.documentationOf.serviceEvent.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
Default ValueEVN
Fixed ValueEVN
500. 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
SlicingThis element introduces a set of slices on ClinicalDocument.documentationOf.serviceEvent.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
501. ClinicalDocument.documentationOf.serviceEvent.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

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

502. ClinicalDocument.documentationOf.serviceEvent.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
503. ClinicalDocument.documentationOf.serviceEvent.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
504. ClinicalDocument.documentationOf.serviceEvent.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
505. ClinicalDocument.documentationOf.serviceEvent.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.21.3.1" (CONF:1198-10068).

Pattern Value2.16.840.1.113883.10.20.21.3.1
506. ClinicalDocument.documentationOf.serviceEvent.templateId:secondary.extension
Definition

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

Control0..1
Typestring
507. ClinicalDocument.documentationOf.serviceEvent.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
508. ClinicalDocument.documentationOf.serviceEvent.code
Definition

Drawn from concept domain ActCode

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
509. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS(USRealmDateandTimeDTUSFIELDED)
Requirements

This serviceEvent SHOULD contain zero or one [0..1] US Realm Date and Time (DT.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:1198-9481).

InvariantsDefined on this element
1198-10066: If a width element is not present, the serviceEvent **SHALL** include effectiveTime/high (CONF:1198-10066). (: )
1198-9482: The serviceEvent/effectiveTime element **SHOULD** be present with effectiveTime/low element (CONF:1198-9482). (: )
81-10078: **SHALL** be precise to the day (CONF:81-10078). (: )
81-10079: **SHOULD** be precise to the minute (CONF:81-10079). (: )
81-10080: **MAY** be precise to the second (CONF:81-10080). (: )
81-10081: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10081). (: )
510. 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
511. 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
512. 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
513. 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
514. 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).

515. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
Definition

This is the high limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
516. 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
517. 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
518. 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).

519. 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
520. 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
521. 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
522. 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
523. 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
524. 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).

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

527. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
528. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
529. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemVersion
Definition

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

Control0..1
Typestring
530. 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
531. 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
532. 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
533. 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
534. 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
535. 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
536. ClinicalDocument.documentationOf.serviceEvent.performer.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
537. 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).

538. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
Default ValueASSIGNED
Fixed ValueASSIGNED
539. 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
540. 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).

541. 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
542. 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
543. 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
544. 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
545. 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
546. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
547. 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).

548. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
549. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
550. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
551. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
552. ClinicalDocument.relatedDocument
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedDocument
553. 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
554. 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

555. 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
556. ClinicalDocument.authorization:authorization1.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueAUT
557. 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
558. 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
559. 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
560. ClinicalDocument.authorization:authorization1.consent
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Consent
Requirements

SHALL contain exactly one [1..1] consent (CONF:1198-16793).

561. ClinicalDocument.authorization:authorization1.consent.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
Default ValueCONS
Fixed ValueCONS
562. ClinicalDocument.authorization:authorization1.consent.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
Default ValueEVN
Fixed ValueEVN
563. 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
564. 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).

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

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

567. 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
568. ClinicalDocument.componentOf
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ComponentOf
Requirements

SHALL contain exactly one [1..1] componentOf (CONF:1198-7595).

569. ClinicalDocument.componentOf.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
570. ClinicalDocument.componentOf.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueAUT
571. ClinicalDocument.componentOf.realmCode
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
572. ClinicalDocument.componentOf.typeId
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
573. ClinicalDocument.componentOf.templateId
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
574. ClinicalDocument.componentOf.encompassingEncounter
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/EncompassingEncounter
Requirements

This componentOf SHALL contain exactly one [1..1] encompassingEncounter (CONF:1198-7596).

575. ClinicalDocument.componentOf.encompassingEncounter.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
Default ValueENC
Fixed ValueENC
576. ClinicalDocument.componentOf.encompassingEncounter.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
Default ValueEVN
Fixed ValueEVN
577. ClinicalDocument.componentOf.encompassingEncounter.templateId
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
578. ClinicalDocument.componentOf.encompassingEncounter.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

579. ClinicalDocument.componentOf.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
580. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime
Definition

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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS(USRealmDateandTimeDTUSFIELDED)
Requirements

This encompassingEncounter SHALL contain exactly one [1..1] US Realm Date and Time (DT.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:1198-7598).

InvariantsDefined on this element
81-10078: **SHALL** be precise to the day (CONF:81-10078). (: )
81-10079: **SHOULD** be precise to the minute (CONF:81-10079). (: )
81-10080: **MAY** be precise to the second (CONF:81-10080). (: )
81-10081: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10081). (: )
581. ClinicalDocument.componentOf.encompassingEncounter.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
582. ClinicalDocument.componentOf.encompassingEncounter.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
583. ClinicalDocument.componentOf.encompassingEncounter.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
584. ClinicalDocument.componentOf.encompassingEncounter.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
585. ClinicalDocument.componentOf.encompassingEncounter.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-7599).

586. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime.high
Definition

This is the high limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
587. ClinicalDocument.componentOf.encompassingEncounter.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
588. ClinicalDocument.componentOf.encompassingEncounter.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
589. ClinicalDocument.componentOf.encompassingEncounter.sdtcAdmissionReferralSourceCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
590. ClinicalDocument.componentOf.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
591. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty
Control0..1
TypeElement
592. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Default ValueRESP
Fixed ValueRESP
593. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
594. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/EncounterParticipant
595. ClinicalDocument.componentOf.encompassingEncounter.location
Control1..1
TypeElement
Requirements

This encompassingEncounter SHALL contain exactly one [1..1] location (CONF:1198-30879).

596. ClinicalDocument.componentOf.encompassingEncounter.location.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetLocation
Typecode
Default ValueLOC
Fixed ValueLOC
597. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/HealthCareFacility
Requirements

This location SHALL contain exactly one [1..1] healthCareFacility (CONF:1198-30880).

598. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassServiceDeliveryLocation
Typecode
Default ValueSDLOC
599. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.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
600. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

601. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
602. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.code
Control0..1
BindingThe codes SHALL be taken from ServiceDeliveryLocationRoleType; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
603. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Place
604. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.serviceProviderOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
605. ClinicalDocument.component
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Component2
Requirements

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

606. 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
607. ClinicalDocument.component.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Fixed ValueAUT
608. ClinicalDocument.component.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
609. 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
610. 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
611. 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
612. ClinicalDocument.component.nonXMLBody
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/NonXMLBody
613. ClinicalDocument.component.structuredBody
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/StructuredBody
Requirements

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

InvariantsDefined on this element
1198-30657: This structuredBody **SHALL** contain an Assessment and Plan Section (V2) (2.16.840.1.113883.10.20.22.2.9:2014-06-09), or an Assessment Section (2.16.840.1.113883.10.20.22.2.8) and a Plan of Treatment Section (V2) (2.16.840.1.113883.10.20.22.2.10:2014-06-09) (CONF:1198-30657). (: )
1198-30658: This structuredBody **SHALL NOT** contain an Assessment and Plan Section (V2) (2.16.840.1.113883.10.20.22.2.9:2014-06-09) when either an Assessment Section (2.16.840.1.113883.10.20.22.2.8) or a Plan of Treatment Section (V2) (2.16.840.1.113883.10.20.22.2.10:2014-06-09) is present (CONF:1198-30658). (: )
614. ClinicalDocument.component.structuredBody.classCode
Control1..1
BindingThe codes SHALL be taken from http://terminology.hl7.org/ValueSet/v3-ActClassOrganizer
Typecode
Default ValueDOCBODY
Fixed ValueDOCBODY
615. ClinicalDocument.component.structuredBody.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
Default ValueEVN
Fixed ValueEVN
616. ClinicalDocument.component.structuredBody.confidentialityCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
617. ClinicalDocument.component.structuredBody.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
618. 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
619. ClinicalDocument.component.structuredBody.component.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
620. ClinicalDocument.component.structuredBody.component.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
621. ClinicalDocument.component.structuredBody.component.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section
622. ClinicalDocument.component.structuredBody.component:component1
SliceNamecomponent1
Control0..1
TypeElement
Requirements

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30618).

623. ClinicalDocument.component.structuredBody.component:component1.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
624. ClinicalDocument.component.structuredBody.component:component1.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
625. ClinicalDocument.component.structuredBody.component:component1.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(AssessmentSection)
Requirements

The component, if present, SHALL contain exactly one [1..1] Assessment Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.8) (CONF:1198-30619).

626. ClinicalDocument.component.structuredBody.component:component2
SliceNamecomponent2
Control0..1
TypeElement
Requirements

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

627. ClinicalDocument.component.structuredBody.component:component2.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
628. ClinicalDocument.component.structuredBody.component:component2.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
629. ClinicalDocument.component.structuredBody.component:component2.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(PlanofTreatmentSection)
Requirements

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

630. ClinicalDocument.component.structuredBody.component:component3
SliceNamecomponent3
Control0..1
TypeElement
Requirements

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

631. ClinicalDocument.component.structuredBody.component:component3.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
632. ClinicalDocument.component.structuredBody.component:component3.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
633. ClinicalDocument.component.structuredBody.component:component3.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(AssessmentandPlanSection)
Requirements

SHALL contain exactly one [1..1] Assessment and Plan Section (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.9:2014-06-09) (CONF:1198-30623).

634. ClinicalDocument.component.structuredBody.component:component4
SliceNamecomponent4
Control0..1
TypeElement
Requirements

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

635. ClinicalDocument.component.structuredBody.component:component4.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
636. ClinicalDocument.component.structuredBody.component:component4.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
637. ClinicalDocument.component.structuredBody.component:component4.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(AllergiesAndIntolerancesSectionEntriesOptional)
Requirements

SHALL contain exactly one [1..1] Allergies and Intolerances Section (entries optional) (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.6:2015-08-01) (CONF:1198-30625).

638. ClinicalDocument.component.structuredBody.component:component5
SliceNamecomponent5
Control0..1
TypeElement
Requirements

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

639. ClinicalDocument.component.structuredBody.component:component5.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
640. ClinicalDocument.component.structuredBody.component:component5.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
641. ClinicalDocument.component.structuredBody.component:component5.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(ChiefComplaintSection)
Requirements

SHALL contain exactly one [1..1] Chief Complaint Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.1.13.2.1) (CONF:1198-30627).

642. ClinicalDocument.component.structuredBody.component:component6
SliceNamecomponent6
Control0..1
TypeElement
Requirements

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

643. ClinicalDocument.component.structuredBody.component:component6.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
644. ClinicalDocument.component.structuredBody.component:component6.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
645. ClinicalDocument.component.structuredBody.component:component6.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-30629).

646. ClinicalDocument.component.structuredBody.component:component7
SliceNamecomponent7
Control0..1
TypeElement
Requirements

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

647. ClinicalDocument.component.structuredBody.component:component7.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
648. ClinicalDocument.component.structuredBody.component:component7.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
649. ClinicalDocument.component.structuredBody.component:component7.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(InstructionsSection)
Requirements

SHALL contain exactly one [1..1] Instructions Section (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.45:2014-06-09) (CONF:1198-31386).

650. ClinicalDocument.component.structuredBody.component:component8
SliceNamecomponent8
Control0..1
TypeElement
Requirements

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

651. ClinicalDocument.component.structuredBody.component:component8.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
652. ClinicalDocument.component.structuredBody.component:component8.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
653. ClinicalDocument.component.structuredBody.component:component8.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(MedicationsSectionEntriesOptional)
Requirements

SHALL contain exactly one [1..1] Medications Section (entries optional) (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.1:2014-06-09) (CONF:1198-30642).

654. ClinicalDocument.component.structuredBody.component:component9
SliceNamecomponent9
Control0..1
TypeElement
Requirements

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

655. ClinicalDocument.component.structuredBody.component:component9.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
656. ClinicalDocument.component.structuredBody.component:component9.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
657. ClinicalDocument.component.structuredBody.component:component9.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(ObjectiveSection)
Requirements

SHALL contain exactly one [1..1] Objective Section (identifier: urn:oid:2.16.840.1.113883.10.20.21.2.1) (CONF:1198-30644).

658. ClinicalDocument.component.structuredBody.component:component10
SliceNamecomponent10
Control0..1
TypeElement
Requirements

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

659. ClinicalDocument.component.structuredBody.component:component10.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
660. ClinicalDocument.component.structuredBody.component:component10.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
661. ClinicalDocument.component.structuredBody.component:component10.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(PhysicalExamSection)
Requirements

SHALL contain exactly one [1..1] Physical Exam Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.2.10:2015-08-01) (CONF:1198-30646).

662. ClinicalDocument.component.structuredBody.component:component11
SliceNamecomponent11
Control0..1
TypeElement
Requirements

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

663. ClinicalDocument.component.structuredBody.component:component11.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
664. ClinicalDocument.component.structuredBody.component:component11.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
665. ClinicalDocument.component.structuredBody.component:component11.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(ProblemSectionEntriesOptional)
Requirements

SHALL contain exactly one [1..1] Problem Section (entries optional) (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.5:2015-08-01) (CONF:1198-30648).

666. ClinicalDocument.component.structuredBody.component:component12
SliceNamecomponent12
Control0..1
TypeElement
Requirements

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

667. ClinicalDocument.component.structuredBody.component:component12.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
668. ClinicalDocument.component.structuredBody.component:component12.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
669. ClinicalDocument.component.structuredBody.component:component12.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(ResultsSectionEntriesOptional)
Requirements

SHALL contain exactly one [1..1] Results Section (entries optional) (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.3:2015-08-01) (CONF:1198-30650).

670. ClinicalDocument.component.structuredBody.component:component13
SliceNamecomponent13
Control0..1
TypeElement
Requirements

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

671. ClinicalDocument.component.structuredBody.component:component13.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
672. ClinicalDocument.component.structuredBody.component:component13.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
673. ClinicalDocument.component.structuredBody.component:component13.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(ReviewofSystemsSection)
Requirements

SHALL contain exactly one [1..1] Review of Systems Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.3.18) (CONF:1198-30652).

674. ClinicalDocument.component.structuredBody.component:component14
SliceNamecomponent14
Control0..1
TypeElement
Requirements

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

675. ClinicalDocument.component.structuredBody.component:component14.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
676. ClinicalDocument.component.structuredBody.component:component14.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
677. ClinicalDocument.component.structuredBody.component:component14.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(SubjectiveSection)
Requirements

SHALL contain exactly one [1..1] Subjective Section (identifier: urn:oid:2.16.840.1.113883.10.20.21.2.2) (CONF:1198-30654).

678. ClinicalDocument.component.structuredBody.component:component15
SliceNamecomponent15
Control0..1
TypeElement
Requirements

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

679. ClinicalDocument.component.structuredBody.component:component15.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
680. ClinicalDocument.component.structuredBody.component:component15.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
681. ClinicalDocument.component.structuredBody.component:component15.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(VitalSignsSectionEntriesOptional)
Requirements

SHALL contain exactly one [1..1] Vital Signs Section (entries optional) (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.4:2015-08-01) (CONF:1198-30656).

682. ClinicalDocument.component.structuredBody.component:component16
SliceNamecomponent16
Control0..1
TypeElement
Requirements

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

683. ClinicalDocument.component.structuredBody.component:component16.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
684. ClinicalDocument.component.structuredBody.component:component16.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
685. ClinicalDocument.component.structuredBody.component:component16.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(NutritionSection)
Requirements

SHALL contain exactly one [1..1] Nutrition Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.57) (CONF:1198-32627).