Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build United States of America

This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: CarePlan - Detailed Descriptions

Active as of 2023-01-16

Definitions for the 2.16.840.1.113883.10.20.22.1.15 resource profile.

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

1. ClinicalDocument
2. ClinicalDocument.templateId
SlicingThis element introduces a set of slices on ClinicalDocument.templateId. The slices are and , and can be differentiated using the following discriminators:
  • @
  • @ ,
3. ClinicalDocument.templateId:secondary
SliceNamesecondary
Control1..1
Requirements

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

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

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

Pattern Value2.16.840.1.113883.10.20.22.1.15
5. ClinicalDocument.templateId:secondary.extension
Control1..1
Requirements

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

Pattern Value2015-08-01
6. ClinicalDocument.code
Requirements

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

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

7. ClinicalDocument.code.code
Control1..1
BindingThe codes SHALL be taken from Care Plan Document Type
Requirements

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

8. ClinicalDocument.setId
Requirements

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

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

9. ClinicalDocument.versionNumber
Requirements

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

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

10. ClinicalDocument.informationRecipient
SlicingThis element introduces a set of slices on ClinicalDocument.informationRecipient. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ intendedRecipient
11. ClinicalDocument.informationRecipient:informationRecipient1
SliceNameinformationRecipient1
Control0..*
Requirements

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

12. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient
Control1..1
Requirements

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

13. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.id
Control1..*
Requirements

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

14. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.addr
Control0..*
Requirements

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

15. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.telecom
Control0..*
Requirements

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

16. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.informationRecipient
Control0..1
Requirements

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

17. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.informationRecipient.name
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED)
Requirements

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

18. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization
Control0..1
Requirements

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

19. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.id
Control0..*
Requirements

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

20. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.name
Control1..*
Requirements

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

21. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.standardIndustryClassCode
Control0..1
BindingThe codes SHALL be taken from Healthcare Provider Taxonomy
Requirements

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

22. ClinicalDocument.authenticator:authenticator2
SliceNameauthenticator2
Control0..1
Requirements

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

23. ClinicalDocument.authenticator:authenticator2.signatureText
Control0..1
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.
Requirements

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

24. ClinicalDocument.authenticator:authenticator2.time
Control1..1
Requirements

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

25. ClinicalDocument.authenticator:authenticator2.signatureCode
Control1..1
Requirements

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

26. ClinicalDocument.authenticator:authenticator2.assignedEntity
Control1..1
Requirements

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

27. ClinicalDocument.authenticator:authenticator2.assignedEntity.id
Control1..*
Requirements

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

28. ClinicalDocument.authenticator:authenticator2.assignedEntity.code
Control1..1
Requirements

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

29. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.code
Control1..1
Requirements

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

Pattern ValueONESELF
30. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.codeSystem
Control1..1
Requirements

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

Pattern Value2.16.840.1.113883.5.111
31. ClinicalDocument.participant
SlicingThis element introduces a set of slices on ClinicalDocument.participant. The slices are and , and can be differentiated using the following discriminators:
  • value @ typeCode
32. ClinicalDocument.participant:participant1
SliceNameparticipant1
Requirements

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

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

33. ClinicalDocument.participant:participant1.typeCode
Control10..1
Requirements

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

Pattern ValueVRF
34. ClinicalDocument.participant:participant1.functionCode
Control10..1
Requirements

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

35. ClinicalDocument.participant:participant1.functionCode.code
Control1..1
Requirements

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

Pattern Value425268008
36. ClinicalDocument.participant:participant1.functionCode.codeSystem
Control1..1
Requirements

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

Pattern Value2.16.840.1.113883.6.96
37. ClinicalDocument.participant:participant1.time
Control10..1
Requirements

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

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

38. ClinicalDocument.participant:participant1.associatedEntity
Requirements

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

39. ClinicalDocument.participant:participant1.associatedEntity.classCode
Control1..1
Requirements

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

Pattern ValueASSIGNED
40. ClinicalDocument.participant:participant1.associatedEntity.id
Control1..*
Requirements

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

41. ClinicalDocument.participant:participant1.associatedEntity.code
Control0..1
Requirements

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

42. ClinicalDocument.participant:participant1.associatedEntity.code.code
Control1..1
BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type
Requirements

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

43. ClinicalDocument.participant:participant2
SliceNameparticipant2
Control0..*
Requirements

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

44. ClinicalDocument.participant:participant2.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="IND" Indirect (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:1198-31896).

Pattern ValueIND
45. ClinicalDocument.participant:participant2.associatedEntity
Control1..1
Requirements

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

46. ClinicalDocument.participant:participant2.associatedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from INDRoleclassCodes
Requirements

This associatedEntity SHALL contain exactly one [1..1] @classCode, which SHALL be selected from ValueSet INDRoleclassCodes urn:oid:2.16.840.1.113883.11.20.9.33 STATIC (CONF:1198-31898).

47. ClinicalDocument.participant:participant2.associatedEntity.associatedPerson
Control1..1
Requirements

This associatedEntity SHALL contain exactly one [1..1] associatedPerson (CONF:1198-31899).

48. ClinicalDocument.participant:participant2.associatedEntity.associatedPerson.name
Control1..*
Requirements

This associatedPerson SHALL contain at least one [1..*] name (CONF:1198-31900).

49. ClinicalDocument.documentationOf
SlicingThis element introduces a set of slices on ClinicalDocument.documentationOf. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ serviceEvent
50. ClinicalDocument.documentationOf:documentationOf1
SliceNamedocumentationOf1
Control1..1
Requirements

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

51. ClinicalDocument.documentationOf:documentationOf1.serviceEvent
Control1..1
Requirements

SHALL contain exactly one [1..1] serviceEvent (CONF:1198-31902).

52. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.classCode
Control1..1
Requirements

This serviceEvent SHALL contain exactly one [1..1] @classCode="PCPR" Care Provision (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1198-31903).

Pattern ValuePCPR
53. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime
Control1..1
Requirements

This serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:1198-31904).

54. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime.low
Control1..1
Requirements

This effectiveTime SHALL contain exactly one [1..1] low (CONF:1198-32330).

55. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime.high
Control0..1
Requirements

This effectiveTime MAY contain zero or one [0..1] high (CONF:1198-32331).

56. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer
Control0..?
SlicingThis element introduces a set of slices on ClinicalDocument.documentationOf.serviceEvent.performer. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ assignedEntity
57. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1
SliceNameperformer1
Control1..*
Requirements

This serviceEvent SHALL contain at least one [1..*] performer (CONF:1198-31905) such that it

58. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity
Control1..1
Requirements

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

59. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.id
Control1..*
Requirements

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

60. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.code
Control0..1
Requirements

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

61. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.assignedPerson
Control1..1
Requirements

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

62. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.assignedPerson.name
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED)
Requirements

This assignedPerson SHALL contain exactly one [1..1] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-32329).

63. ClinicalDocument.relatedDocument
SlicingThis element introduces a set of slices on ClinicalDocument.relatedDocument. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ parentDocument
  • value @ parentDocument,
64. ClinicalDocument.relatedDocument:relatedDocument1
SliceNamerelatedDocument1
Control0..*
Requirements

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

65. ClinicalDocument.relatedDocument:relatedDocument1.typeCode
Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipDocument
Requirements

SHALL contain exactly one [1..1] @typeCode, which SHALL be selected from ValueSet x_ActRelationshipDocument urn:oid:2.16.840.1.113883.1.11.11610 STATIC (CONF:1198-31889).

66. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument
Control1..1
Requirements

SHALL contain exactly one [1..1] parentDocument (CONF:1198-29894).

67. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.id
Control1..*
Requirements

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

68. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.setId
Control1..1
Requirements

This parentDocument SHALL contain exactly one [1..1] setId (CONF:1198-29895).

69. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.versionNumber
Control1..1
Requirements

This parentDocument SHALL contain exactly one [1..1] versionNumber (CONF:1198-29896).

70. ClinicalDocument.componentOf:componentOf1
SliceNamecomponentOf1
Control0..1
Requirements

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

71. ClinicalDocument.componentOf:componentOf1.encompassingEncounter
Control1..1
Requirements

SHALL contain exactly one [1..1] encompassingEncounter (CONF:1198-32005).

72. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.effectiveTime
Control1..1
Requirements

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

73. ClinicalDocument.component
Requirements

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

74. ClinicalDocument.component.structuredBody
Control1..1
Requirements

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

InvariantsDefined on this element
1198-31044: This structuredBody **SHALL NOT** contain a Plan of Treatment Section (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.10:2014-06-09) (CONF:1198-31044). (: null)
75. ClinicalDocument.component.structuredBody.component
Control0..?
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
76. ClinicalDocument.component.structuredBody.component:component1
SliceNamecomponent1
Control1..1
Requirements

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

77. ClinicalDocument.component.structuredBody.component:component1.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(HealthConcernsSection)
Requirements

This component SHALL contain exactly one [1..1] Health Concerns Section (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.58:2015-08-01) (CONF:1198-28756).

78. ClinicalDocument.component.structuredBody.component:component2
SliceNamecomponent2
Control1..1
Requirements

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

79. ClinicalDocument.component.structuredBody.component:component2.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(GoalsSection)
Requirements

SHALL contain exactly one [1..1] Goals Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.60) (CONF:1198-28762).

80. ClinicalDocument.component.structuredBody.component:component3
SliceNamecomponent3
Control0..1
Requirements

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

81. ClinicalDocument.component.structuredBody.component:component3.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(InterventionsSection)
Requirements

SHALL contain exactly one [1..1] Interventions Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.21.2.3:2015-08-01) (CONF:1198-28764).

82. ClinicalDocument.component.structuredBody.component:component4
SliceNamecomponent4
Control0..1
Requirements

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

83. ClinicalDocument.component.structuredBody.component:component4.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(HealthStatusEvaluationsandOutcomesSection)
Requirements

SHALL contain exactly one [1..1] Health Status Evaluations and Outcomes Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.61) (CONF:1198-29597).

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

1. ClinicalDocument
Definition

Base definition for all types defined in FHIR type system.

Control10..1*
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. ClinicalDocument.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass; other codes may be used where these codes are not suitable
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueDOCCLIN
Fixed ValueDOCCLIN
3. ClinicalDocument.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
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.root
Definition

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

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

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

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

Pattern ValuePOCD_HD000040
8. 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 @ root,
9. 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

10. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

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

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

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

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

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

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

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

InvariantsDefined on this element
1198-32934: When asserting this templateId, all C-CDA 2.1 section and entry templates that had a previous version in C-CDA R1.1 **SHALL** include both the C-CDA 2.1 templateId and the C-CDA R1.1 templateId root without an extension. See C-CDA R2.1 Volume 1 - Design Considerations for additional detail (CONF:1198-32934). (: null)
13. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

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

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

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

Pattern Value2015-08-01
15. 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). (: null)
16. ClinicalDocument.code
Control1..1
BindingThe codes SHALL be taken from FHIRDocumentTypeCodes; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

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

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

Control1..1
BindingThe codes SHALL be taken from Care Plan Document Type
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

18. 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
19. ClinicalDocument.title
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ST
Requirements

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

20. 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). (: null)
81-10128: **SHOULD** be precise to the minute (CONF:81-10128). (: null)
81-10129: **MAY** be precise to the second (CONF:81-10129). (: null)
81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). (: null)
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. 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).

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

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

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

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

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

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

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

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

27. ClinicalDocument.recordTarget.patientRole.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassRelationshipFormal
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePAT
Fixed ValuePAT
28. 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).

29. 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). (: null)
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. 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).

31. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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).

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

33. ClinicalDocument.recordTarget.patientRole.patient.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
34. ClinicalDocument.recordTarget.patientRole.patient.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
35. ClinicalDocument.recordTarget.patientRole.patient.name
Definition

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

A name associated with the individual.

Control10..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PNHumanName(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).

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

Comments

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

InvariantsDefined on this element
81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). (: null)
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. 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).

37. 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-5299: **SHALL** be precise to year (CONF:1198-5299). (: null)
1198-5300: **SHOULD** be precise to day (CONF:1198-5300). (: null)
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. (: null)
38. 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).

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

40. ClinicalDocument.author
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
Requirements

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

41. 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). (: null)
81-10128: **SHOULD** be precise to the minute (CONF:81-10128). (: null)
81-10129: **MAY** be precise to the second (CONF:81-10129). (: null)
81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). (: null)
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. 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). (: null)
43. ClinicalDocument.author.assignedAuthor.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
44. 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). (: null)
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
45. 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

46. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

Pattern Value2.16.840.1.113883.4.6
47. 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). (: null)
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
48. 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).

49. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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).

50. 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
51. 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

52. ClinicalDocument.informant:informant1.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

53. ClinicalDocument.informant:informant1.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
54. 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). (: null)
55. 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). (: null)
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
56. 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).

57. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
58. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
59. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name
Definition

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

A name associated with the person.

Control10..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PNHumanName(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).

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

Comments

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

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). (: null)
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: null)
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
60. 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

61. ClinicalDocument.informant:informant2.relatedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
Requirements

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

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

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

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

64. ClinicalDocument.custodian.assignedCustodian.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
65. 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).

66. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassOrganization
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueORG
Fixed ValueORG
67. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
68. 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).

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

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

71. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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).

72. 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). (: null)
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
73. ClinicalDocument.informationRecipient
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/InformationRecipient
Requirements

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

SlicingThis element introduces a set of slices on ClinicalDocument.informationRecipient. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ intendedRecipient
74. 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).

75. ClinicalDocument.informationRecipient.intendedRecipient.classCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
76. ClinicalDocument.informationRecipient:informationRecipient1
SliceNameinformationRecipient1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/InformationRecipient
Requirements

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

77. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IntendedRecipient
Requirements

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

78. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.classCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
79. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

80. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
Requirements

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

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

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

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

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

83. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.informationRecipient.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
84. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.informationRecipient.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
85. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.informationRecipient.name
Definition

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

A name associated with the person.

Control10..1*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PNHumanName(USRealmPersonNamePNUSFIELDED)
Requirements

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

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

Comments

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

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). (: null)
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: null)
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
86. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
Requirements

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

87. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassOrganization
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueORG
Fixed ValueORG
88. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
89. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

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

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

Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

90. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.name
Definition

A name associated with the organization.

Control10..*1 This element is affected by the following invariants: org-1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ONstring
Requirements

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

Need to use the name as the label of the organization.

Comments

If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

91. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.standardIndustryClassCode
Control0..1
BindingThe codes SHALL be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

92. 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 @ signatureCode,
93. 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

94. 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). (: null)
81-10128: **SHOULD** be precise to the minute (CONF:81-10128). (: null)
81-10129: **MAY** be precise to the second (CONF:81-10129). (: null)
81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). (: null)
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
95. ClinicalDocument.authenticator:authenticator1.signatureCode
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

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

96. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
97. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
98. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
99. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemVersion
Definition

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

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
100. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
101. 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
102. 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
103. 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
XML RepresentationThe type of this property is determined using the xsi:type attribute.
104. ClinicalDocument.authenticator:authenticator1.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

105. ClinicalDocument.authenticator:authenticator1.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
106. 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).

107. 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). (: null)
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
108. 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).

109. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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).

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

111. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
112. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
113. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.name
Definition

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

A name associated with the person.

Control10..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PNHumanName(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).

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

Comments

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

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). (: null)
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: null)
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
114. ClinicalDocument.authenticator:authenticator2
SliceNameauthenticator2
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Authenticator
Requirements

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

115. ClinicalDocument.authenticator:authenticator2.time
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Requirements

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

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

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

117. ClinicalDocument.authenticator:authenticator2.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

118. ClinicalDocument.authenticator:authenticator2.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
119. ClinicalDocument.authenticator:authenticator2.assignedEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

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

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

121. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.code
Definition

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

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

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

Specifies the code system that defines the code.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

Pattern Value2.16.840.1.113883.5.111
123. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
124. ClinicalDocument.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant1
SlicingThis element introduces a set of slices on ClinicalDocument.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
125. ClinicalDocument.participant:participant1
SliceNameparticipant1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant1
Requirements

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

InvariantsDefined on this element
1198-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:1198-10006). (: null)
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). (: null)
126. ClinicalDocument.participant:participant1.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

Pattern ValueVRF
127. ClinicalDocument.participant:participant1.functionCode
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

128. ClinicalDocument.participant:participant1.functionCode.code
Definition

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

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

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

Specifies the code system that defines the code.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

Pattern Value2.16.840.1.113883.6.96
130. ClinicalDocument.participant:participant1.functionCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
131. ClinicalDocument.participant:participant1.time
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

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

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

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

133. ClinicalDocument.participant:participant1.associatedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssociative
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

Pattern ValueASSIGNED
134. ClinicalDocument.participant:participant1.associatedEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

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

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

136. ClinicalDocument.participant:participant1.associatedEntity.code.code
Definition

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

Control1..1
BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

137. ClinicalDocument.participant:participant1.associatedEntity.code.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
138. ClinicalDocument.participant:participant2
SliceNameparticipant2
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant1
Requirements

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

139. ClinicalDocument.participant:participant2.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="IND" Indirect (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:1198-31896).

Pattern ValueIND
140. ClinicalDocument.participant:participant2.associatedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssociatedEntity
Requirements

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

141. ClinicalDocument.participant:participant2.associatedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from INDRoleclassCodes
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This associatedEntity SHALL contain exactly one [1..1] @classCode, which SHALL be selected from ValueSet INDRoleclassCodes urn:oid:2.16.840.1.113883.11.20.9.33 STATIC (CONF:1198-31898).

142. ClinicalDocument.participant:participant2.associatedEntity.associatedPerson
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
Requirements

This associatedEntity SHALL contain exactly one [1..1] associatedPerson (CONF:1198-31899).

143. ClinicalDocument.participant:participant2.associatedEntity.associatedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
144. ClinicalDocument.participant:participant2.associatedEntity.associatedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
145. ClinicalDocument.participant:participant2.associatedEntity.associatedPerson.name
Definition

A name associated with the person.

Control10..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ENHumanName
Requirements

This associatedPerson SHALL contain at least one [1..*] name (CONF:1198-31900).

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

Comments

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

146. ClinicalDocument.documentationOf
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/DocumentationOf
Requirements

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

SlicingThis element introduces a set of slices on ClinicalDocument.documentationOf. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ serviceEvent
147. ClinicalDocument.documentationOf.serviceEvent
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ServiceEvent
Requirements

The documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:1198-14836).

148. ClinicalDocument.documentationOf.serviceEvent.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueACT
149. ClinicalDocument.documentationOf.serviceEvent.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueEVN
Fixed ValueEVN
150. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

This serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:1198-14837).

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

152. ClinicalDocument.documentationOf:documentationOf1
SliceNamedocumentationOf1
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/DocumentationOf
Requirements

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

153. ClinicalDocument.documentationOf:documentationOf1.serviceEvent
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ServiceEvent
Requirements

SHALL contain exactly one [1..1] serviceEvent (CONF:1198-31902).

154. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This serviceEvent SHALL contain exactly one [1..1] @classCode="PCPR" Care Provision (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1198-31903).

Default ValueACT
Pattern ValuePCPR
155. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueEVN
Fixed ValueEVN
156. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

This serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:1198-31904).

157. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime.low
Definition

This is the low limit of the interval.

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

This effectiveTime SHALL contain exactly one [1..1] low (CONF:1198-32330).

158. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime.high
Definition

This is the high limit of the interval.

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

This effectiveTime MAY contain zero or one [0..1] high (CONF:1198-32331).

159. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer1
Requirements

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

SlicingThis element introduces a set of slices on ClinicalDocument.documentationOf.serviceEvent.performer. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ assignedEntity
160. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.typeCode
Control1..1
BindingThe codes SHALL be taken from x_ServiceEventPerformer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
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
161. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

162. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
163. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

164. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1
SliceNameperformer1
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer1
Requirements

This serviceEvent SHALL contain at least one [1..*] performer (CONF:1198-31905) such that it

165. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.typeCode
Control1..1
BindingThe codes SHALL be taken from x_ServiceEventPerformer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
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
166. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

167. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
168. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

169. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.code
Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

170. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.assignedPerson
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
Requirements

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

171. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.assignedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
172. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.assignedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
173. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.assignedPerson.name
Definition

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

A name associated with the person.

Control10..1*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PNHumanName(USRealmPersonNamePNUSFIELDED)
Requirements

This assignedPerson SHALL contain exactly one [1..1] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-32329).

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

Comments

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

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). (: null)
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: null)
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
174. ClinicalDocument.relatedDocument
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedDocument
SlicingThis element introduces a set of slices on ClinicalDocument.relatedDocument. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ parentDocument
  • value @ parentDocument,
175. ClinicalDocument.relatedDocument:relatedDocument1
SliceNamerelatedDocument1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedDocument
Requirements

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

176. ClinicalDocument.relatedDocument:relatedDocument1.typeCode
Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipDocument
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode, which SHALL be selected from ValueSet x_ActRelationshipDocument urn:oid:2.16.840.1.113883.1.11.11610 STATIC (CONF:1198-31889).

177. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParentDocument
Requirements

SHALL contain exactly one [1..1] parentDocument (CONF:1198-29894).

178. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.classCode
Control1..1
BindingThe codes SHALL be taken from ActClassClinicalDocument
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueDOCCLIN
Fixed ValueDOCCLIN
179. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueEVN
Fixed ValueEVN
180. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

181. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.setId
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

This parentDocument SHALL contain exactly one [1..1] setId (CONF:1198-29895).

182. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.versionNumber
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
Requirements

This parentDocument SHALL contain exactly one [1..1] versionNumber (CONF:1198-29896).

183. 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
184. 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

185. ClinicalDocument.authorization:authorization1.consent
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Consent
Requirements

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

186. ClinicalDocument.authorization:authorization1.consent.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCONS
Fixed ValueCONS
187. ClinicalDocument.authorization:authorization1.consent.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueEVN
Fixed ValueEVN
188. 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).

189. ClinicalDocument.authorization:authorization1.consent.statusCode.code
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
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
190. ClinicalDocument.componentOf:componentOf1
SliceNamecomponentOf1
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ComponentOf
Requirements

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

191. ClinicalDocument.componentOf:componentOf1.encompassingEncounter
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/EncompassingEncounter
Requirements

SHALL contain exactly one [1..1] encompassingEncounter (CONF:1198-32005).

192. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueENC
Fixed ValueENC
193. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueEVN
Fixed ValueEVN
194. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

195. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

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

196. ClinicalDocument.component
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Component2
Requirements

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

197. ClinicalDocument.component.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
198. ClinicalDocument.component.structuredBody
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/StructuredBody
Requirements

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

InvariantsDefined on this element
1198-31044: This structuredBody **SHALL NOT** contain a Plan of Treatment Section (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.10:2014-06-09) (CONF:1198-31044). (: null)
199. ClinicalDocument.component.structuredBody.classCode
Control1..1
BindingThe codes SHALL be taken from ActClassRecordOrganizer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueDOCBODY
Fixed ValueDOCBODY
200. ClinicalDocument.component.structuredBody.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueEVN
Fixed ValueEVN
201. ClinicalDocument.component.structuredBody.component
Control1..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
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
202. ClinicalDocument.component.structuredBody.component.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
203. ClinicalDocument.component.structuredBody.component.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
204. ClinicalDocument.component.structuredBody.component.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section
205. ClinicalDocument.component.structuredBody.component:component1
SliceNamecomponent1
Control1..1
TypeElement
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
206. ClinicalDocument.component.structuredBody.component:component1.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
207. ClinicalDocument.component.structuredBody.component:component1.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
208. ClinicalDocument.component.structuredBody.component:component1.section
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(HealthConcernsSection)
Requirements

This component SHALL contain exactly one [1..1] Health Concerns Section (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.58:2015-08-01) (CONF:1198-28756).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
209. ClinicalDocument.component.structuredBody.component:component2
SliceNamecomponent2
Control1..1
TypeElement
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
210. ClinicalDocument.component.structuredBody.component:component2.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
211. ClinicalDocument.component.structuredBody.component:component2.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
212. ClinicalDocument.component.structuredBody.component:component2.section
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(GoalsSection)
Requirements

SHALL contain exactly one [1..1] Goals Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.60) (CONF:1198-28762).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
213. ClinicalDocument.component.structuredBody.component:component3
SliceNamecomponent3
Control0..1
TypeElement
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
214. ClinicalDocument.component.structuredBody.component:component3.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
215. ClinicalDocument.component.structuredBody.component:component3.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
216. ClinicalDocument.component.structuredBody.component:component3.section
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(InterventionsSection)
Requirements

SHALL contain exactly one [1..1] Interventions Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.21.2.3:2015-08-01) (CONF:1198-28764).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
217. ClinicalDocument.component.structuredBody.component:component4
SliceNamecomponent4
Control0..1
TypeElement
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
218. ClinicalDocument.component.structuredBody.component:component4.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
219. ClinicalDocument.component.structuredBody.component:component4.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
220. ClinicalDocument.component.structuredBody.component:component4.section
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(HealthStatusEvaluationsandOutcomesSection)
Requirements

SHALL contain exactly one [1..1] Health Status Evaluations and Outcomes Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.61) (CONF:1198-29597).

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

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

1. ClinicalDocument
Definition

Base definition for all types defined in FHIR type system.

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
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueDOCCLIN
Fixed ValueDOCCLIN
3. ClinicalDocument.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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 @ root,
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.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
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

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

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

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

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

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

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

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

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

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

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

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

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

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

InvariantsDefined on this element
1198-9992: This code **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:1198-9992). (: )
1198-32948: This code **SHALL** be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:1198-32948). (: )
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
XML RepresentationIn the XML format, this property is represented as an attribute.
27. ClinicalDocument.code.code
Definition

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

Control1..1
BindingThe codes SHALL be taken from Care Plan Document Type
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

28. ClinicalDocument.code.codeSystem
Definition

Specifies the code system that defines the code.

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

The common name of the coding system.

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

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet.
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
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion.
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
XML RepresentationThe type of this property is determined using the xsi:type attribute.
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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. ClinicalDocument.confidentialityCode
Control1..1
BindingThe codes SHOULD be taken from HL7 BasicConfidentialityKind
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

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

SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:1198-5372).

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

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

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

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

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

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

45. ClinicalDocument.recordTarget.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
46. ClinicalDocument.recordTarget.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueRCT
47. ClinicalDocument.recordTarget.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueOP
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
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
XML RepresentationIn the XML format, this property is represented as an attribute.
59. ClinicalDocument.recordTarget.patientRole.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
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
Default Typehttp://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
XML RepresentationThe type of this property is determined using the xsi:type attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
64. ClinicalDocument.recordTarget.patientRole.patient.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
68. ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name desc.
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-5299: **SHALL** be precise to year (CONF:1198-5299). (: )
1198-5300: **SHOULD** be precise to day (CONF:1198-5300). (: )
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. (: )
71. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name deceasedInd.
72. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name deceasedTime.
73. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name multipleBirthInd.
74. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT-POS
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name multipleBirthOrderNumber.
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
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name raceCode.
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).

InvariantsDefined on this element
1198-31347: If sdtc:raceCode is present, then the patient SHALL contain [1..1] raceCode (CONF:1198-31347). (: )
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
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name ethnicGroupCode.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
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
XML RepresentationIn the XML format, this property is represented as an attribute.
90. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
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
Default Typehttp://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
XML RepresentationThe type of this property is determined using the xsi:type attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
95. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
98. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name asPatientRelationship.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePLC
Fixed ValuePLC
105. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
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). Note: A nullFlavor of ' UNK' may be used if the state is unknown. (: )
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
113. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
114. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
115. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
116. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
117. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
118. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
119. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
120. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
121. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
122. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
123. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
124. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
125. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueDEL
126. 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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
127. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
128. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
129. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
130. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
131. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
132. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
133. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
134. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
135. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
136. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
137. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
138. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
139. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueCNT
140. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
141. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
142. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
143. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
144. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
145. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
146. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
147. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
148. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
149. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
150. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
151. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
152. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
153. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueSTA
154. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
155. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
156. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
157. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
158. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
159. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
160. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
161. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
162. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
163. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
164. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
165. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
166. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
167. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueCPA
168. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
169. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
170. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
171. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
172. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
173. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
174. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
175. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
176. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
177. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
178. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
179. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
180. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
181. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueCTY
182. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
183. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
184. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
185. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
186. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
187. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
188. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
189. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
190. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
191. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
192. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
193. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
194. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
195. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueZIP
196. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine
Definition

Street address line

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
197. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
198. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
199. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
200. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
201. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
202. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
203. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
204. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
205. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
206. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
207. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
208. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
209. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueSAL
210. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
211. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
212. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
213. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
214. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
215. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
216. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
217. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
218. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
219. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
220. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
221. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
222. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
223. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueBNR
224. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric
Definition

The numeric portion of a building number

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
225. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
226. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
227. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
228. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
229. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
230. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
231. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
232. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
233. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
234. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
235. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
236. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
237. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueBNN
238. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
239. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
240. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
241. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
242. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
243. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
244. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
245. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
246. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
247. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
248. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
249. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
250. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
251. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueDIR
252. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
253. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
254. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
255. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
256. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
257. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
258. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
259. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
260. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
261. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
262. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
263. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
264. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
265. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueSTR
266. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
267. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
268. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
269. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
270. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
271. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
272. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
273. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
274. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
275. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
276. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
277. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
278. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
279. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueSTB
280. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
281. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
282. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
283. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
284. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
285. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
286. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
287. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
288. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
289. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
290. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
291. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
292. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
293. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueSTTYP
294. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
295. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
296. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
297. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
298. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
299. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
300. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
301. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
302. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
303. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
304. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
305. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
306. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
307. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueADL
308. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
309. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
310. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
311. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
312. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
313. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
314. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
315. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
316. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
317. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
318. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
319. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
320. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
321. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueUNID
322. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
323. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
324. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
325. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
326. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
327. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
328. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
329. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
330. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
331. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
332. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
333. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
334. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
335. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueUNIT
336. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
337. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
338. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
339. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
340. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
341. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
342. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
343. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
344. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
345. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
346. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
347. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
348. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
349. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueCAR
350. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
351. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
352. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
353. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
354. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
355. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
356. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
357. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
358. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
359. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
360. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
361. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
362. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
363. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueCEN
364. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
365. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
366. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
367. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
368. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
369. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
370. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
371. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
372. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
373. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
374. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
375. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
376. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
377. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueDAL
378. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
379. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
380. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
381. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
382. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
383. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
384. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
385. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
386. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
387. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
388. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
389. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
390. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
391. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueDINST
392. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
393. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
394. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
395. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
396. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
397. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
398. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
399. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
400. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
401. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
402. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
403. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
404. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
405. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueDINSTA
406. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
407. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
408. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
409. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
410. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
411. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
412. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
413. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
414. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
415. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
416. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
417. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
418. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
419. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueDINSTQ
420. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
421. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
422. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
423. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
424. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
425. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
426. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
427. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
428. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
429. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
430. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
431. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
432. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
433. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueDMOD
434. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
435. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
436. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
437. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
438. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
439. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
440. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
441. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
442. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
443. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
444. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
445. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
446. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
447. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueDMODID
448. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
449. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
450. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
451. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
452. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
453. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
454. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
455. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
456. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
457. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
458. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
459. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
460. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
461. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueBNS
462. 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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
463. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
464. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
465. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
466. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
467. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
468. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
469. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
470. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
471. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
472. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
473. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
474. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
475. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValuePOB
476. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct
Definition

A subsection of a municipality

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ADXP
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
477. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
478. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.charset
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
479. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
480. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
481. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
482. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
483. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
484. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.representation
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
485. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
486. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
487. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
488. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
489. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.partType
Definition

Specifies the type of the address part

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValuePRE
490. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.other
Definition

Textual representation of (part of) the address

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as unadorned text.
491. 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
Default Typehttp://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationThe type of this property is determined using the xsi:type attribute.
492. 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).

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

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

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

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

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

499. ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassOrganization
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueORG
Fixed ValueORG
500. ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
501. 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
502. 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).

503. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
504. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
505. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
506. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
507. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
508. 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).

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

510. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
511. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
512. 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
Default Typehttp://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
XML RepresentationThe type of this property is determined using the xsi:type attribute.
513. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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).

514. 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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
515. 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
516. ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/OrganizationPartOf
517. ClinicalDocument.author
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
Requirements

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

518. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
519. ClinicalDocument.author.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueAUT
520. ClinicalDocument.author.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueOP
521. 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
522. 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
523. 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
524. ClinicalDocument.author.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
525. 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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
526. 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). (: )
527. ClinicalDocument.author.assignedAuthor.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
528. 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
529. 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
530. 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

531. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
532. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
533. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
534. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

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

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

536. ClinicalDocument.author.assignedAuthor.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
537. 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).

538. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
539. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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).

540. ClinicalDocument.author.assignedAuthor.code.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
541. ClinicalDocument.author.assignedAuthor.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
542. ClinicalDocument.author.assignedAuthor.code.codeSystemVersion
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
543. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
544. 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
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet.
545. 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
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion.
546. 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
547. 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
548. 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
XML RepresentationThe type of this property is determined using the xsi:type attribute.
549. 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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
550. 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).

551. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
552. ClinicalDocument.author.assignedAuthor.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
553. 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
Default Typehttp://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
XML RepresentationThe type of this property is determined using the xsi:type attribute.
554. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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).

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

556. ClinicalDocument.author.assignedAuthor.assignedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
557. ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
558. 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
559. 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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
560. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name asPatientRelationship.
561. 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).

562. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassDevice
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueDEV
Fixed ValueDEV
563. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
564. 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
565. 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
566. 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).

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

568. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/MaintainedEntity
569. ClinicalDocument.author.assignedAuthor.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
570. ClinicalDocument.dataEnterer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/DataEnterer
Requirements

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

571. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
572. ClinicalDocument.dataEnterer.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueENT
573. ClinicalDocument.dataEnterer.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueOP
574. 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
575. 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
576. 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
577. ClinicalDocument.dataEnterer.time
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
578. 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).

579. ClinicalDocument.dataEnterer.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
580. 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
581. 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).

582. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
583. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
584. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
585. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
586. ClinicalDocument.dataEnterer.assignedEntity.id.extension
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
587. ClinicalDocument.dataEnterer.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
588. 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).

589. 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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
590. 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).

591. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
592. ClinicalDocument.dataEnterer.assignedEntity.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
593. 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
Default Typehttp://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
XML RepresentationThe type of this property is determined using the xsi:type attribute.
594. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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).

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

596. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
597. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
598. 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
599. 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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
600. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name asPatientRelationship.
601. ClinicalDocument.dataEnterer.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
602. 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
603. 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

604. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
605. ClinicalDocument.informant:informant1.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueINF
606. ClinicalDocument.informant:informant1.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueOP
607. 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
608. 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
609. 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
610. ClinicalDocument.informant:informant1.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

611. ClinicalDocument.informant:informant1.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
612. 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
613. 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). (: )
614. ClinicalDocument.informant:informant1.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
615. 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).

616. 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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
617. ClinicalDocument.informant:informant1.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
618. 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).

619. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
620. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
621. 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
622. 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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
623. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name asPatientRelationship.
624. ClinicalDocument.informant:informant1.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
625. ClinicalDocument.informant:informant1.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
626. 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

627. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
628. ClinicalDocument.informant:informant2.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueINF
629. ClinicalDocument.informant:informant2.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueOP
630. 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
631. 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
632. 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
633. ClinicalDocument.informant:informant2.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
634. ClinicalDocument.informant:informant2.relatedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
Requirements

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

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

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

636. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
637. ClinicalDocument.custodian.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueENT
638. 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
639. 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
640. 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
641. 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).

642. ClinicalDocument.custodian.assignedCustodian.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
643. 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
644. 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).

645. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassOrganization
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueORG
Fixed ValueORG
646. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
647. 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
648. 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).

649. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
650. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
651. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
652. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
653. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.extension
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
654. 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).

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

656. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
657. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
658. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.useablePeriod
Definition

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

Control0..*
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
XML RepresentationThe type of this property is determined using the xsi:type attribute.
659. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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).

660. 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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
661. ClinicalDocument.informationRecipient
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/InformationRecipient
Requirements

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

SlicingThis element introduces a set of slices on ClinicalDocument.informationRecipient. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ intendedRecipient
662. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
663. ClinicalDocument.informationRecipient.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePRCP
664. 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
665. 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
666. 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
667. 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).

668. ClinicalDocument.informationRecipient.intendedRecipient.classCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
669. 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
670. 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).

671. ClinicalDocument.informationRecipient.intendedRecipient.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
672. ClinicalDocument.informationRecipient.intendedRecipient.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
673. ClinicalDocument.informationRecipient.intendedRecipient.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
674. 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).

675. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
676. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
677. 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
678. 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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
679. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name asPatientRelationship.
680. 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).

681. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassOrganization
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueORG
Fixed ValueORG
682. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
683. 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
684. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
685. 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).

686. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
687. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
688. 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
689. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/OrganizationPartOf
690. ClinicalDocument.informationRecipient:informationRecipient1
SliceNameinformationRecipient1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/InformationRecipient
Requirements

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

691. ClinicalDocument.informationRecipient:informationRecipient1.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
692. ClinicalDocument.informationRecipient:informationRecipient1.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePRCP
693. ClinicalDocument.informationRecipient:informationRecipient1.realmCode
Definition

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

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

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

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

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

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

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

697. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.classCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
698. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.templateId
Definition

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

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

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

700. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
701. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
Requirements

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

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

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

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

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

704. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.informationRecipient.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
705. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.informationRecipient.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
706. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.informationRecipient.templateId
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
707. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.informationRecipient.name
Definition

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

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

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

InvariantsDefined on this element
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (: )
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
708. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.informationRecipient.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name asPatientRelationship.
709. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
Requirements

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

710. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassOrganization
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueORG
Fixed ValueORG
711. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
712. ClinicalDocument.informationRecipient:informationRecipient1.intendedRecipient.receivedOrganization.templateId
Definition

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

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

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

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

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

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

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

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

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

720. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
721. ClinicalDocument.legalAuthenticator.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueLA
722. ClinicalDocument.legalAuthenticator.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueOP
723. 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
724. 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
725. 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
726. 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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
727. 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).

728. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
729. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
730. ClinicalDocument.legalAuthenticator.signatureCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
731. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
732. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemVersion
Definition

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

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
733. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
734. 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
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet.
735. 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
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion.
736. 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
737. 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
738. 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
XML RepresentationThe type of this property is determined using the xsi:type attribute.
739. ClinicalDocument.legalAuthenticator.sdtcSignatureText
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name signatureText.
740. 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).

741. ClinicalDocument.legalAuthenticator.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
742. 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
743. 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).

744. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
745. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
746. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
747. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
748. ClinicalDocument.legalAuthenticator.assignedEntity.id.extension
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
749. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
750. 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).

751. 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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
752. 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).

753. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
754. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
755. 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
Default Typehttp://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
XML RepresentationThe type of this property is determined using the xsi:type attribute.
756. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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).

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

758. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
759. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
760. 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
761. 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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
762. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name asPatientRelationship.
763. ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
764. 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 @ signatureCode,
765. 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

766. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
767. ClinicalDocument.authenticator:authenticator1.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueAUTHEN
768. 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
769. 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
770. 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
771. 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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
772. ClinicalDocument.authenticator:authenticator1.signatureCode
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

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

773. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
774. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
775. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
776. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
777. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemVersion
Definition

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

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
778. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
779. 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
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet.
780. 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
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion.
781. 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
782. 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
783. 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
XML RepresentationThe type of this property is determined using the xsi:type attribute.
784. ClinicalDocument.authenticator:authenticator1.sdtcSignatureText
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name signatureText.
785. ClinicalDocument.authenticator:authenticator1.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

786. ClinicalDocument.authenticator:authenticator1.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
787. 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
788. 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).

789. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
790. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
791. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
792. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
793. ClinicalDocument.authenticator:authenticator1.assignedEntity.id.extension
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
794. ClinicalDocument.authenticator:authenticator1.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
795. 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).

796. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
797. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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).

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

Specifies the code system that defines the code.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
799. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
800. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codeSystemVersion
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
801. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
802. 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
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet.
803. 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
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion.
804. 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
805. 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
806. 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
XML RepresentationThe type of this property is determined using the xsi:type attribute.
807. 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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
808. 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).

809. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
810. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
811. 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
Default Typehttp://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
XML RepresentationThe type of this property is determined using the xsi:type attribute.
812. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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).

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

814. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
815. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
816. 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
817. 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). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
818. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name asPatientRelationship.
819. ClinicalDocument.authenticator:authenticator1.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
820. ClinicalDocument.authenticator:authenticator2
SliceNameauthenticator2
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Authenticator
Requirements

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

821. ClinicalDocument.authenticator:authenticator2.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
822. ClinicalDocument.authenticator:authenticator2.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueAUTHEN
823. ClinicalDocument.authenticator:authenticator2.realmCode
Definition

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

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

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

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

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

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

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

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

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

828. ClinicalDocument.authenticator:authenticator2.sdtcSignatureText
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name signatureText.
829. ClinicalDocument.authenticator:authenticator2.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

830. ClinicalDocument.authenticator:authenticator2.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
831. ClinicalDocument.authenticator:authenticator2.assignedEntity.templateId
Definition

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

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

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

833. ClinicalDocument.authenticator:authenticator2.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
834. ClinicalDocument.authenticator:authenticator2.assignedEntity.code
Control1..1
BindingThe codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

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

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
836. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.code
Definition

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

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

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

Specifies the code system that defines the code.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

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

The common name of the coding system.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
839. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.codeSystemVersion
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
840. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.displayName
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
841. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.sdtcValueSet
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet.
842. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.sdtcValueSetVersion
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion.
843. ClinicalDocument.authenticator:authenticator2.assignedEntity.code.originalText
Definition

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

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

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

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

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
846. ClinicalDocument.authenticator:authenticator2.assignedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
847. ClinicalDocument.authenticator:authenticator2.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
848. ClinicalDocument.authenticator:authenticator2.assignedEntity.assignedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
849. ClinicalDocument.authenticator:authenticator2.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
850. ClinicalDocument.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant1
SlicingThis element introduces a set of slices on ClinicalDocument.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
851. ClinicalDocument.participant:participant1
SliceNameparticipant1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant1
Requirements

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

InvariantsDefined on this element
1198-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:1198-10006). (: )
1198-10007: When participant/@typeCode is *IND*, associatedEntity/@classCode **SHOULD** be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *STATIC 2011-09-30* (CONF:1198-10007). (: )
852. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
853. ClinicalDocument.participant:participant1.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

Pattern ValueVRF
854. ClinicalDocument.participant:participant1.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueOP
855. 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
856. 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
857. 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
858. ClinicalDocument.participant:participant1.functionCode
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

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

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
860. ClinicalDocument.participant:participant1.functionCode.code
Definition

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

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

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

Specifies the code system that defines the code.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

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

The common name of the coding system.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
863. ClinicalDocument.participant:participant1.functionCode.codeSystemVersion
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
864. ClinicalDocument.participant:participant1.functionCode.displayName
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
865. ClinicalDocument.participant:participant1.functionCode.sdtcValueSet
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet.
866. ClinicalDocument.participant:participant1.functionCode.sdtcValueSetVersion
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion.
867. ClinicalDocument.participant:participant1.functionCode.originalText
Definition

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

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

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

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

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
870. ClinicalDocument.participant:participant1.time
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

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

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

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

872. ClinicalDocument.participant:participant1.associatedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssociative
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

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

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

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

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

875. ClinicalDocument.participant:participant1.associatedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
876. ClinicalDocument.participant:participant1.associatedEntity.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

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

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
878. ClinicalDocument.participant:participant1.associatedEntity.code.code
Definition

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

Control1..1
BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

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

Specifies the code system that defines the code.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
880. ClinicalDocument.participant:participant1.associatedEntity.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
881. ClinicalDocument.participant:participant1.associatedEntity.code.codeSystemVersion
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
882. ClinicalDocument.participant:participant1.associatedEntity.code.displayName
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
883. ClinicalDocument.participant:participant1.associatedEntity.code.sdtcValueSet
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet.
884. ClinicalDocument.participant:participant1.associatedEntity.code.sdtcValueSetVersion
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion.
885. ClinicalDocument.participant:participant1.associatedEntity.code.originalText
Definition

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

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

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
887. ClinicalDocument.participant:participant1.associatedEntity.code.translation
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
888. ClinicalDocument.participant:participant1.associatedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
889. ClinicalDocument.participant:participant1.associatedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
890. ClinicalDocument.participant:participant1.associatedEntity.associatedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
891. ClinicalDocument.participant:participant1.associatedEntity.scopingOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
892. ClinicalDocument.participant:participant2
SliceNameparticipant2
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant1
Requirements

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

893. ClinicalDocument.participant:participant2.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
894. ClinicalDocument.participant:participant2.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="IND" Indirect (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:1198-31896).

Pattern ValueIND
895. ClinicalDocument.participant:participant2.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueOP
896. ClinicalDocument.participant:participant2.realmCode
Definition

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

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

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

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

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
899. ClinicalDocument.participant:participant2.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
900. ClinicalDocument.participant:participant2.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
901. ClinicalDocument.participant:participant2.associatedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssociatedEntity
Requirements

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

902. ClinicalDocument.participant:participant2.associatedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from INDRoleclassCodes
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This associatedEntity SHALL contain exactly one [1..1] @classCode, which SHALL be selected from ValueSet INDRoleclassCodes urn:oid:2.16.840.1.113883.11.20.9.33 STATIC (CONF:1198-31898).

903. ClinicalDocument.participant:participant2.associatedEntity.templateId
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
904. ClinicalDocument.participant:participant2.associatedEntity.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
905. ClinicalDocument.participant:participant2.associatedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
906. ClinicalDocument.participant:participant2.associatedEntity.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
907. ClinicalDocument.participant:participant2.associatedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
908. ClinicalDocument.participant:participant2.associatedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
909. ClinicalDocument.participant:participant2.associatedEntity.associatedPerson
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
Requirements

This associatedEntity SHALL contain exactly one [1..1] associatedPerson (CONF:1198-31899).

910. ClinicalDocument.participant:participant2.associatedEntity.associatedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
911. ClinicalDocument.participant:participant2.associatedEntity.associatedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
912. ClinicalDocument.participant:participant2.associatedEntity.associatedPerson.templateId
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
913. ClinicalDocument.participant:participant2.associatedEntity.associatedPerson.name
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/EN
Requirements

This associatedPerson SHALL contain at least one [1..*] name (CONF:1198-31900).

914. ClinicalDocument.participant:participant2.associatedEntity.associatedPerson.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name asPatientRelationship.
915. ClinicalDocument.participant:participant2.associatedEntity.scopingOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
916. ClinicalDocument.inFulfillmentOf
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/InFulfillmentOf
Requirements

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

917. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
918. ClinicalDocument.inFulfillmentOf.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueFLFS
919. 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
920. 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
921. 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
922. 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).

923. ClinicalDocument.inFulfillmentOf.order.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueACT
924. ClinicalDocument.inFulfillmentOf.order.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMoodIntent
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueRQO
Fixed ValueRQO
925. 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
926. 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).

927. 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
928. 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
929. ClinicalDocument.documentationOf
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/DocumentationOf
Requirements

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

SlicingThis element introduces a set of slices on ClinicalDocument.documentationOf. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ serviceEvent
930. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
931. ClinicalDocument.documentationOf.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueDOC
932. 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
933. 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
934. 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
935. ClinicalDocument.documentationOf.serviceEvent
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ServiceEvent
Requirements

The documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:1198-14836).

936. ClinicalDocument.documentationOf.serviceEvent.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueACT
937. ClinicalDocument.documentationOf.serviceEvent.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueEVN
Fixed ValueEVN
938. 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
939. ClinicalDocument.documentationOf.serviceEvent.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
940. ClinicalDocument.documentationOf.serviceEvent.code
Definition

Drawn from concept domain ActCode

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
941. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

This serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:1198-14837).

942. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
943. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
944. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
945. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
946. 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).

947. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
Definition

This is the high limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
948. 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
949. 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
950. 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).

951. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
952. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode
Control1..1
BindingThe codes SHALL be taken from x_ServiceEventPerformer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
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
953. 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
954. 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
955. 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
956. 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).

957. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
958. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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).

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

Specifies the code system that defines the code.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
960. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
961. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemVersion
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
962. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
963. 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
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet.
964. 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
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion.
965. 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
966. 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
967. 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
XML RepresentationThe type of this property is determined using the xsi:type attribute.
968. ClinicalDocument.documentationOf.serviceEvent.performer.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
969. 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).

970. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
971. 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
972. 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).

973. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
974. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
975. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
976. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
977. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
978. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
979. 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).

980. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
981. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
982. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
983. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
984. ClinicalDocument.documentationOf:documentationOf1
SliceNamedocumentationOf1
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/DocumentationOf
Requirements

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

985. ClinicalDocument.documentationOf:documentationOf1.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
986. ClinicalDocument.documentationOf:documentationOf1.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueDOC
987. ClinicalDocument.documentationOf:documentationOf1.realmCode
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
988. ClinicalDocument.documentationOf:documentationOf1.typeId
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
989. ClinicalDocument.documentationOf:documentationOf1.templateId
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
990. ClinicalDocument.documentationOf:documentationOf1.serviceEvent
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ServiceEvent
Requirements

SHALL contain exactly one [1..1] serviceEvent (CONF:1198-31902).

991. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This serviceEvent SHALL contain exactly one [1..1] @classCode="PCPR" Care Provision (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1198-31903).

Default ValueACT
Pattern ValuePCPR
992. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueEVN
Fixed ValueEVN
993. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.templateId
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
994. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
995. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.code
Definition

Drawn from concept domain ActCode

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
996. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

This serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:1198-31904).

997. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
998. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime.value
Definition

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

Control0..1
TypedateTime
XML RepresentationIn the XML format, this property is represented as an attribute.
999. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime.inclusive
Definition

Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).

Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
1000. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime.operator
Definition

A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
1001. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime.low
Definition

This is the low limit of the interval.

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

This effectiveTime SHALL contain exactly one [1..1] low (CONF:1198-32330).

1002. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime.high
Definition

This is the high limit of the interval.

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

This effectiveTime MAY contain zero or one [0..1] high (CONF:1198-32331).

1003. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime.width
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
1004. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.effectiveTime.center
Definition

The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
1005. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer1
Requirements

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

SlicingThis element introduces a set of slices on ClinicalDocument.documentationOf.serviceEvent.performer. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ assignedEntity
1006. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
1007. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.typeCode
Control1..1
BindingThe codes SHALL be taken from x_ServiceEventPerformer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
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
1008. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.realmCode
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
1009. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.typeId
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
1010. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.templateId
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
1011. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:1198-16818).

1012. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
1013. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.code
Definition

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

Control0..1
BindingThe codes SHOULD be taken from Care Team Member Function
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
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).

1014. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
1015. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
1016. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.codeSystemVersion
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
1017. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.displayName
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
1018. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.sdtcValueSet
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet.
1019. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.sdtcValueSetVersion
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion.
1020. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
1021. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
1022. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.functionCode.translation
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
1023. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
1024. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

1025. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
1026. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.templateId
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
1027. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

1028. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.id.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
1029. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.id.assigningAuthorityName
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
1030. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.id.displayable
Definition

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

Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
1031. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.id.root
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
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
1032. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.id.extension
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
1033. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
1034. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.code
Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

1035. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
1036. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
1037. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.assignedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
1038. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
1039. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1
SliceNameperformer1
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer1
Requirements

This serviceEvent SHALL contain at least one [1..*] performer (CONF:1198-31905) such that it

1040. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
1041. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.typeCode
Control1..1
BindingThe codes SHALL be taken from x_ServiceEventPerformer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
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
1042. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.realmCode
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
1043. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.typeId
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
1044. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.templateId
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
1045. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:1198-16818).

1046. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
1047. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.code
Definition

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

Control0..1
BindingThe codes SHOULD be taken from Care Team Member Function
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
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).

1048. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
1049. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
1050. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.codeSystemVersion
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
1051. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.displayName
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
1052. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.sdtcValueSet
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet.
1053. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.sdtcValueSetVersion
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion.
1054. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
1055. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
1056. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.functionCode.translation
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
1057. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
1058. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

1059. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
1060. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.templateId
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
1061. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

1062. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.id.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
1063. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.id.assigningAuthorityName
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
1064. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.id.displayable
Definition

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

Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
1065. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.id.root
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
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
1066. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.id.extension
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
1067. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
1068. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.code
Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

1069. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
1070. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
1071. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.assignedPerson
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
Requirements

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

1072. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.assignedPerson.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
1073. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.assignedPerson.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
1074. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.assignedPerson.templateId
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
1075. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.assignedPerson.name
Definition

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

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

This assignedPerson SHALL contain exactly one [1..1] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-32329).

InvariantsDefined on this element
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (: )
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1076. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name asPatientRelationship.
1077. ClinicalDocument.documentationOf:documentationOf1.serviceEvent.performer:performer1.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
1078. ClinicalDocument.relatedDocument
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedDocument
SlicingThis element introduces a set of slices on ClinicalDocument.relatedDocument. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ parentDocument
  • value @ parentDocument,
1079. ClinicalDocument.relatedDocument:relatedDocument1
SliceNamerelatedDocument1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedDocument
Requirements

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

1080. ClinicalDocument.relatedDocument:relatedDocument1.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
1081. ClinicalDocument.relatedDocument:relatedDocument1.typeCode
Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipDocument
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode, which SHALL be selected from ValueSet x_ActRelationshipDocument urn:oid:2.16.840.1.113883.1.11.11610 STATIC (CONF:1198-31889).

1082. ClinicalDocument.relatedDocument:relatedDocument1.realmCode
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
1083. ClinicalDocument.relatedDocument:relatedDocument1.typeId
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
1084. ClinicalDocument.relatedDocument:relatedDocument1.templateId
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
1085. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParentDocument
Requirements

SHALL contain exactly one [1..1] parentDocument (CONF:1198-29894).

1086. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.classCode
Control1..1
BindingThe codes SHALL be taken from ActClassClinicalDocument
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueDOCCLIN
Fixed ValueDOCCLIN
1087. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueEVN
Fixed ValueEVN
1088. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.templateId
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
1089. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

1090. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.code
Control0..1
BindingThe codes SHALL be taken from FHIRDocumentTypeCodes; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
1091. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
1092. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.setId
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

This parentDocument SHALL contain exactly one [1..1] setId (CONF:1198-29895).

1093. ClinicalDocument.relatedDocument:relatedDocument1.parentDocument.versionNumber
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
Requirements

This parentDocument SHALL contain exactly one [1..1] versionNumber (CONF:1198-29896).

1094. 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
1095. 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

1096. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
1097. ClinicalDocument.authorization:authorization1.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueAUT
1098. 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
1099. 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
1100. 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
1101. ClinicalDocument.authorization:authorization1.consent
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Consent
Requirements

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

1102. ClinicalDocument.authorization:authorization1.consent.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCONS
Fixed ValueCONS
1103. ClinicalDocument.authorization:authorization1.consent.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueEVN
Fixed ValueEVN
1104. 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
1105. 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).

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

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

1108. ClinicalDocument.authorization:authorization1.consent.statusCode.code
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
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
1109. ClinicalDocument.componentOf:componentOf1
SliceNamecomponentOf1
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ComponentOf
Requirements

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

1110. ClinicalDocument.componentOf:componentOf1.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
1111. ClinicalDocument.componentOf:componentOf1.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueAUT
1112. ClinicalDocument.componentOf:componentOf1.realmCode
Definition

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

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

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

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

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

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

SHALL contain exactly one [1..1] encompassingEncounter (CONF:1198-32005).

1116. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueENC
Fixed ValueENC
1117. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueEVN
Fixed ValueEVN
1118. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.templateId
Definition

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

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

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

1120. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.code
Control0..1
BindingThe codes SHALL be taken from ActEncounterCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
1121. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

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

1122. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.sdtcAdmissionReferralSourceCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name admissionReferralSourceCode.
1123. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.dischargeDispositionCode
Control0..1
BindingThe codes SHALL be taken from USEncounterDischargeDisposition; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
1124. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.responsibleParty
Control0..1
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1125. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.responsibleParty.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
1126. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.responsibleParty.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1127. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.responsibleParty.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueRESP
Fixed ValueRESP
1128. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.responsibleParty.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
1129. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.encounterParticipant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/EncounterParticipant
1130. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.location
Control0..1
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1131. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.location.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
1132. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.location.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ClinicalDocument.componentOf.encompassingEncounter.location.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1133. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.location.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetLocation
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueLOC
Fixed ValueLOC
1134. ClinicalDocument.componentOf:componentOf1.encompassingEncounter.location.healthCareFacility
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/HealthCareFacility
1135. ClinicalDocument.component
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Component2
Requirements

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

1136. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
1137. ClinicalDocument.component.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueAUT
1138. ClinicalDocument.component.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1139. 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
1140. 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
1141. 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
1142. ClinicalDocument.component.nonXMLBody
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/NonXMLBody
1143. ClinicalDocument.component.structuredBody
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/StructuredBody
Requirements

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

InvariantsDefined on this element
1198-31044: This structuredBody **SHALL NOT** contain a Plan of Treatment Section (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.10:2014-06-09) (CONF:1198-31044). (: )
1144. ClinicalDocument.component.structuredBody.classCode
Control1..1
BindingThe codes SHALL be taken from ActClassRecordOrganizer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueDOCBODY
Fixed ValueDOCBODY
1145. ClinicalDocument.component.structuredBody.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueEVN
Fixed ValueEVN
1146. ClinicalDocument.component.structuredBody.confidentialityCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
1147. ClinicalDocument.component.structuredBody.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
1148. ClinicalDocument.component.structuredBody.component
Control1..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
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
1149. ClinicalDocument.component.structuredBody.component.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
1150. ClinicalDocument.component.structuredBody.component.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ClinicalDocument.component.structuredBody.component.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1151. ClinicalDocument.component.structuredBody.component.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1152. ClinicalDocument.component.structuredBody.component.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1153. ClinicalDocument.component.structuredBody.component.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section
1154. ClinicalDocument.component.structuredBody.component:component1
SliceNamecomponent1
Control1..1
TypeElement
Requirements

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

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

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
1156. ClinicalDocument.component.structuredBody.component:component1.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ClinicalDocument.component.structuredBody.component.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1157. ClinicalDocument.component.structuredBody.component:component1.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1158. ClinicalDocument.component.structuredBody.component:component1.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1159. ClinicalDocument.component.structuredBody.component:component1.section
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(HealthConcernsSection)
Requirements

This component SHALL contain exactly one [1..1] Health Concerns Section (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.58:2015-08-01) (CONF:1198-28756).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1160. ClinicalDocument.component.structuredBody.component:component2
SliceNamecomponent2
Control1..1
TypeElement
Requirements

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

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

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
1162. ClinicalDocument.component.structuredBody.component:component2.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ClinicalDocument.component.structuredBody.component.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1163. ClinicalDocument.component.structuredBody.component:component2.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1164. ClinicalDocument.component.structuredBody.component:component2.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1165. ClinicalDocument.component.structuredBody.component:component2.section
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(GoalsSection)
Requirements

SHALL contain exactly one [1..1] Goals Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.60) (CONF:1198-28762).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1166. ClinicalDocument.component.structuredBody.component:component3
SliceNamecomponent3
Control0..1
TypeElement
Requirements

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

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

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
1168. ClinicalDocument.component.structuredBody.component:component3.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ClinicalDocument.component.structuredBody.component.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1169. ClinicalDocument.component.structuredBody.component:component3.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1170. ClinicalDocument.component.structuredBody.component:component3.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1171. ClinicalDocument.component.structuredBody.component:component3.section
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(InterventionsSection)
Requirements

SHALL contain exactly one [1..1] Interventions Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.21.2.3:2015-08-01) (CONF:1198-28764).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1172. ClinicalDocument.component.structuredBody.component:component4
SliceNamecomponent4
Control0..1
TypeElement
Requirements

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

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

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
1174. ClinicalDocument.component.structuredBody.component:component4.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ClinicalDocument.component.structuredBody.component.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1175. ClinicalDocument.component.structuredBody.component:component4.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1176. ClinicalDocument.component.structuredBody.component:component4.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1177. ClinicalDocument.component.structuredBody.component:component4.section
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(HealthStatusEvaluationsandOutcomesSection)
Requirements

SHALL contain exactly one [1..1] Health Status Evaluations and Outcomes Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.61) (CONF:1198-29597).

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