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

Active as of 2023-01-16

Definitions for the 2.16.840.1.113883.10.20.22.1.13 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:primary
SliceNameprimary
Requirements

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

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

InvariantsDefined on this element
1198-32946: 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-32946). (: null)
4. ClinicalDocument.templateId:primary.root
Requirements

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

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.13
5. ClinicalDocument.templateId:primary.extension
Requirements

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

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

6. ClinicalDocument.code
BindingThe codes SHALL be taken from TransferDocumentTypeThe codes SHALL be taken from FHIRDocumentTypeCodes; other codes may be used where these codes are not suitable
Requirements

SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet TransferDocumentType http://hl7.org/fhir/ccda/ValueSet/2.16.840.1.113883.1.11.20.2.4 DYNAMIC (CONF:1198-28243).

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

7. ClinicalDocument.title
Requirements

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

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

8. 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
9. ClinicalDocument.participant:participant1
SliceNameparticipant1
Requirements

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

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

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

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

Pattern ValueIND
11. ClinicalDocument.participant:participant1.associatedEntity
Requirements

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

12. ClinicalDocument.participant:participant1.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 DYNAMIC (CONF:1198-31873).

13. ClinicalDocument.participant:participant1.associatedEntity.associatedPerson
Control1..1
Requirements

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

14. ClinicalDocument.participant:participant1.associatedEntity.associatedPerson.name
Control1..*
Requirements

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

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

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

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

SHALL contain exactly one [1..1] @typeCode="CALLBCK" Call back contact (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:1198-31627).

Pattern ValueCALLBCK
17. ClinicalDocument.participant:participant2.associatedEntity
Control1..1
Requirements

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

18. ClinicalDocument.participant:participant2.associatedEntity.classCode
Control1..1
Requirements

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

Pattern ValueASSIGNED
19. ClinicalDocument.participant:participant2.associatedEntity.id
Control1..*
Requirements

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

20. ClinicalDocument.participant:participant2.associatedEntity.addr
Control0..*
Requirements

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

21. ClinicalDocument.participant:participant2.associatedEntity.telecom
Control1..*
Requirements

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

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

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

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

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

24. ClinicalDocument.participant:participant2.associatedEntity.scopingOrganization
Control0..1
Requirements

This associatedEntity MAY contain zero or one [0..1] scopingOrganization (CONF:1198-31634).

25. ClinicalDocument.documentationOf
Control10..1*
Requirements

SHALL contain exactly one [1..1] documentationOf (CONF:1198-31570).

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

26. ClinicalDocument.documentationOf.serviceEvent
Requirements

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

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

27. ClinicalDocument.documentationOf.serviceEvent.classCode
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-31572).

Pattern ValuePCPR
28. ClinicalDocument.documentationOf.serviceEvent.code
Requirements

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

29. ClinicalDocument.documentationOf.serviceEvent.performer
SlicingThis element introduces a set of slices on ClinicalDocument.documentationOf.serviceEvent.performer. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
30. ClinicalDocument.documentationOf.serviceEvent.performer:performer1
SliceNameperformer1
Control1..*
Requirements

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

31. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="PRF" Participation of Physical Performer (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 DYNAMIC) (CONF:1198-31575).

Pattern ValuePRF
32. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode
Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Requirements

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

33. ClinicalDocument.component
Requirements

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

34. ClinicalDocument.component.structuredBody
Control1..1
Requirements

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

InvariantsDefined on this element
1198-31582: This structuredBody **SHALL** contain an Assessment and Plan Section (V2) (2.16.840.1.113883.10.20.22.2.9:2014-06-09), or an Assessment Section (2.16.840.1.113883.10.20.22.2.8) and a Plan of Treatment Section (V2) (2.16.840.1.113883.10.20.22.2.10:2014-06-09) (CONF:1198-31582). (: null)
1198-31583: This structuredBody **SHALL NOT** contain an Assessment and Plan Section (V2) (2.16.840.1.113883.10.20.22.2.9:2014-06-09) when either an Assessment Section (2.16.840.1.113883.10.20.22.2.8) or a Plan of Treatment Section (V2) (2.16.840.1.113883.10.20.22.2.10:2014-06-09) is present (CONF:1198-31583). (: null)
35. ClinicalDocument.component.structuredBody.component
Control0..1
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 @ section.code
36. ClinicalDocument.component.structuredBody.component:advanceDirectives
SliceNameadvanceDirectives
Control0..1
Requirements

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

37. ClinicalDocument.component.structuredBody.component:advanceDirectives.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(AdvanceDirectivesSectionentriesrequired)
Requirements

The component, if present, SHALL contain exactly one [1..1] Advance Directives Section (entries required) (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.21.1:2015-08-01) (CONF:1198-28254).

38. ClinicalDocument.component.structuredBody.component:allergiesAndIntolerances
SliceNameallergiesAndIntolerances
Control1..1
Requirements

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

39. ClinicalDocument.component.structuredBody.component:allergiesAndIntolerances.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(AllergiesAndIntolerancesSectionEntriesRequired)
Requirements

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

40. ClinicalDocument.component.structuredBody.component:physicalExam
SliceNamephysicalExam
Control0..1
Requirements

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

41. ClinicalDocument.component.structuredBody.component:physicalExam.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(PhysicalExamSection)
Requirements

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

42. ClinicalDocument.component.structuredBody.component:encounters
SliceNameencounters
Control0..1
Requirements

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

43. ClinicalDocument.component.structuredBody.component:encounters.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(EncountersSectionentriesrequired)
Requirements

SHALL contain exactly one [1..1] Encounters Section (entries required) (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.22.1:2015-08-01) (CONF:1198-28262).

44. ClinicalDocument.component.structuredBody.component:familyHistory
SliceNamefamilyHistory
Control0..1
Requirements

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

45. ClinicalDocument.component.structuredBody.component:familyHistory.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(FamilyHistorySection)
Requirements

SHALL contain exactly one [1..1] Family History Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.15:2015-08-01) (CONF:1198-28264).

46. ClinicalDocument.component.structuredBody.component:functionalStatus
SliceNamefunctionalStatus
Control0..1
Requirements

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

47. ClinicalDocument.component.structuredBody.component:functionalStatus.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(FunctionalStatusSection)
Requirements

SHALL contain exactly one [1..1] Functional Status Section (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.14:2014-06-09) (CONF:1198-28266).

48. ClinicalDocument.component.structuredBody.component:dischargeDiagnosis
SliceNamedischargeDiagnosis
Control0..1
Requirements

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

49. ClinicalDocument.component.structuredBody.component:dischargeDiagnosis.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(DischargeDiagnosisSection)
Requirements

SHALL contain exactly one [1..1] Discharge Diagnosis Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.24:2015-08-01) (CONF:1198-28272).

50. ClinicalDocument.component.structuredBody.component:immunizations
SliceNameimmunizations
Control0..1
Requirements

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

51. ClinicalDocument.component.structuredBody.component:immunizations.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(ImmunizationsSectionEntriesOptional)
Requirements

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

52. ClinicalDocument.component.structuredBody.component:medicalEquip
SliceNamemedicalEquip
Control0..1
Requirements

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

53. ClinicalDocument.component.structuredBody.component:medicalEquip.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(MedicalEquipmentSection)
Requirements

SHALL contain exactly one [1..1] Medical Equipment Section (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.23:2014-06-09) (CONF:1198-28276).

54. ClinicalDocument.component.structuredBody.component:medications
SliceNamemedications
Control1..1
Requirements

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

55. ClinicalDocument.component.structuredBody.component:medications.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(MedicationsSectionEntriesRequired)
Requirements

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

56. ClinicalDocument.component.structuredBody.component:payers
SliceNamepayers
Control0..1
Requirements

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

57. ClinicalDocument.component.structuredBody.component:payers.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(PayersSection)
Requirements

SHALL contain exactly one [1..1] Payers Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.18:2015-08-01) (CONF:1198-28280).

58. ClinicalDocument.component.structuredBody.component:planOfTreatment
SliceNameplanOfTreatment
Control0..1
Requirements

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

59. ClinicalDocument.component.structuredBody.component:planOfTreatment.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(PlanofTreatmentSection)
Requirements

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

60. ClinicalDocument.component.structuredBody.component:problem
SliceNameproblem
Control1..1
Requirements

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

61. ClinicalDocument.component.structuredBody.component:problem.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(ProblemSectionEntriesRequired)
Requirements

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

62. ClinicalDocument.component.structuredBody.component:procedures
SliceNameprocedures
Control0..1
Requirements

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

63. ClinicalDocument.component.structuredBody.component:procedures.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(ProceduresSectionentriesrequired)
Requirements

SHALL contain exactly one [1..1] Procedures Section (entries required) (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.7.1:2014-06-09) (CONF:1198-28286).

64. ClinicalDocument.component.structuredBody.component:results
SliceNameresults
Control1..1
Requirements

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

65. ClinicalDocument.component.structuredBody.component:results.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(ResultsSectionEntriesRequired)
Requirements

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

66. ClinicalDocument.component.structuredBody.component:socialHistory
SliceNamesocialHistory
Control0..1
Requirements

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

67. ClinicalDocument.component.structuredBody.component:socialHistory.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(SocialHistorySection)
Requirements

SHALL contain exactly one [1..1] Social History Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.17:2015-08-01) (CONF:1198-28290).

68. ClinicalDocument.component.structuredBody.component:vitalSigns
SliceNamevitalSigns
Control1..1
Requirements

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

69. ClinicalDocument.component.structuredBody.component:vitalSigns.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(VitalSignsSectionEntriesRequired)
Requirements

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

70. ClinicalDocument.component.structuredBody.component:mentalStatus
SliceNamementalStatus
Control0..1
Requirements

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

71. ClinicalDocument.component.structuredBody.component:mentalStatus.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(MentalStatusSection)
Requirements

SHALL contain exactly one [1..1] Mental Status Section (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.56:2015-08-01) (CONF:1198-28328).

72. ClinicalDocument.component.structuredBody.component:generalStatus
SliceNamegeneralStatus
Control0..1
Requirements

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

73. ClinicalDocument.component.structuredBody.component:generalStatus.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(GeneralStatusSection)
Requirements

SHALL contain exactly one [1..1] General Status Section (identifier: urn:oid:2.16.840.1.113883.10.20.2.5) (CONF:1198-28839).

74. ClinicalDocument.component.structuredBody.component:reviewOfSystems
SliceNamereviewOfSystems
Control0..1
Requirements

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

75. ClinicalDocument.component.structuredBody.component:reviewOfSystems.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(ReviewofSystemsSection)
Requirements

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

76. ClinicalDocument.component.structuredBody.component:nutrition
SliceNamenutrition
Control0..1
Requirements

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

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

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

78. ClinicalDocument.component.structuredBody.component:reasonForReferral
SliceNamereasonForReferral
Control1..1
Requirements

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

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

SHALL contain exactly one [1..1] Reason for Referral Section (V2) (identifier: urn:hl7ii:1.3.6.1.4.1.19376.1.5.3.1.3.1:2014-06-09) (CONF:1198-31343).

80. ClinicalDocument.component.structuredBody.component:pastMedicalHistory
SliceNamepastMedicalHistory
Control0..1
Requirements

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

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

SHALL contain exactly one [1..1] Past Medical History (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.20:2015-08-01) (CONF:1198-31562).

82. ClinicalDocument.component.structuredBody.component:historyOfPresentIllness
SliceNamehistoryOfPresentIllness
Control0..1
Requirements

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

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

SHALL contain exactly one [1..1] History of Present Illness Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.3.4) (CONF:1198-31564).

84. ClinicalDocument.component.structuredBody.component:assessmentAndPlan
SliceNameassessmentAndPlan
Control0..1
Requirements

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

85. ClinicalDocument.component.structuredBody.component:assessmentAndPlan.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(AssessmentandPlanSection)
Requirements

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

86. ClinicalDocument.component.structuredBody.component:assessment
SliceNameassessment
Control0..1
Requirements

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

87. ClinicalDocument.component.structuredBody.component:assessment.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(AssessmentSection)
Requirements

SHALL contain exactly one [1..1] Assessment Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.8) (CONF:1198-31568).

88. ClinicalDocument.component.structuredBody.component:admissionMedications
SliceNameadmissionMedications
Control0..1
Requirements

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

89. ClinicalDocument.component.structuredBody.component:admissionMedications.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(AdmissionMedicationsSectionentriesoptional)
Requirements

SHALL contain exactly one [1..1] Admission Medications Section (entries optional) (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.44:2015-08-01) (CONF:1198-32446).

90. ClinicalDocument.component.structuredBody.component:admissionDiagnosis
SliceNameadmissionDiagnosis
Control0..1
Requirements

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

91. ClinicalDocument.component.structuredBody.component:admissionDiagnosis.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(AdmissionDiagnosisSection)
Requirements

SHALL contain exactly one [1..1] Admission Diagnosis Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.43:2015-08-01) (CONF:1198-32448).

92. ClinicalDocument.component.structuredBody.component:courseOfCare
SliceNamecourseOfCare
Control0..1
Requirements

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

93. ClinicalDocument.component.structuredBody.component:courseOfCare.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section(CourseofCareSection)
Requirements

SHALL contain exactly one [1..1] Course of Care Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.64) (CONF:1198-32649).

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-28239) such that it

InvariantsDefined on this element
1198-32946: 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-32946). (: null)
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.13" (CONF:1198-28240).

Pattern Value2.16.840.1.113883.10.20.22.1.13
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-32907).

Pattern Value2015-08-01
12. 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)
13. ClinicalDocument.code
Control1..1
BindingThe codes SHALL be taken from TransferDocumentType
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet TransferDocumentType http://hl7.org/fhir/ccda/ValueSet/2.16.840.1.113883.1.11.20.2.4 DYNAMIC (CONF:1198-28243).

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

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

15. 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()))
16. 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).

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

18. ClinicalDocument.recordTarget
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/RecordTarget
Requirements

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

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

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

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

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

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

26. 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
27. 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
28. 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()))
29. 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).

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

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

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

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

34. 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()))
35. 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)
36. 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
37. 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
38. 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

39. 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
40. 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()))
41. 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).

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

43. 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
44. 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

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

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

46. 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
47. 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)
48. 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()))
49. 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).

50. 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
51. 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
52. 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()))
53. 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

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

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

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

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

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

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

59. 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
60. 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
61. 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).

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

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

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

65. 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()))
66. 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,
67. 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

68. 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()))
69. ClinicalDocument.authenticator:authenticator1.signatureCode
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

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

70. 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
71. 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.
72. 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.
73. 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.
74. 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.
75. 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
76. 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
77. 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.
78. ClinicalDocument.authenticator:authenticator1.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

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

81. 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()))
82. 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).

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

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

85. 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
86. 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
87. 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()))
88. 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
89. ClinicalDocument.participant:participant1
SliceNameparticipant1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant1
Requirements

SHOULD contain zero or more [0..*] participant (CONF:1198-31599) 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)
90. 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="IND" indirect (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:1198-31872).

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

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

92. ClinicalDocument.participant:participant1.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 DYNAMIC (CONF:1198-31873).

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

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

94. ClinicalDocument.participant:participant1.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
95. ClinicalDocument.participant:participant1.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
96. ClinicalDocument.participant:participant1.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-31602).

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.

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

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

98. 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="CALLBCK" Call back contact (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:1198-31627).

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

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

100. ClinicalDocument.participant:participant2.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" assigned entity (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110) (CONF:1198-31641).

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

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

102. ClinicalDocument.participant:participant2.associatedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
Requirements

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

103. ClinicalDocument.participant:participant2.associatedEntity.telecom
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Requirements

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

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

105. 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
106. 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
107. 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-31633).

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.

108. ClinicalDocument.participant:participant2.associatedEntity.scopingOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
Requirements

This associatedEntity MAY contain zero or one [0..1] scopingOrganization (CONF:1198-31634).

109. ClinicalDocument.documentationOf
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/DocumentationOf
Requirements

SHALL contain exactly one [1..1] documentationOf (CONF:1198-31570).

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

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

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

Default ValueACT
Pattern ValuePCPR
112. 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
113. ClinicalDocument.documentationOf.serviceEvent.code
Definition

Drawn from concept domain ActCode

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

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

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

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

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

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

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

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

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

122. ClinicalDocument.documentationOf.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

SHALL contain exactly one [1..1] @typeCode="PRF" Participation of Physical Performer (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 DYNAMIC) (CONF:1198-31575).

Fixed ValueDOC
Pattern ValuePRF
123. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode
Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

124. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
125. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.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).

126. ClinicalDocument.documentationOf.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
127. ClinicalDocument.documentationOf.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-14846).

128. 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
129. 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

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

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

131. 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
132. 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
133. 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).

134. 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
135. ClinicalDocument.component
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Component2
Requirements

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

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

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

InvariantsDefined on this element
1198-31582: This structuredBody **SHALL** contain an Assessment and Plan Section (V2) (2.16.840.1.113883.10.20.22.2.9:2014-06-09), or an Assessment Section (2.16.840.1.113883.10.20.22.2.8) and a Plan of Treatment Section (V2) (2.16.840.1.113883.10.20.22.2.10:2014-06-09) (CONF:1198-31582). (: null)
1198-31583: This structuredBody **SHALL NOT** contain an Assessment and Plan Section (V2) (2.16.840.1.113883.10.20.22.2.9:2014-06-09) when either an Assessment Section (2.16.840.1.113883.10.20.22.2.8) or a Plan of Treatment Section (V2) (2.16.840.1.113883.10.20.22.2.10:2014-06-09) is present (CONF:1198-31583). (: null)
138. 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
139. 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
140. ClinicalDocument.component.structuredBody.component
Control0..1
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 @ section.code
141. ClinicalDocument.component.structuredBody.component.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
142. ClinicalDocument.component.structuredBody.component.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
143. ClinicalDocument.component.structuredBody.component.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section
144. ClinicalDocument.component.structuredBody.component:advanceDirectives
SliceNameadvanceDirectives
Control0..1
TypeElement
Requirements

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

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

Base definition for all types defined in FHIR type system.

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

The component, if present, SHALL contain exactly one [1..1] Advance Directives Section (entries required) (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.21.1:2015-08-01) (CONF:1198-28254).

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

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

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

Base definition for all types defined in FHIR type system.

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

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

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

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

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

Base definition for all types defined in FHIR type system.

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

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

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

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

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Encounters Section (entries required) (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.22.1:2015-08-01) (CONF:1198-28262).

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

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

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Family History Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.15:2015-08-01) (CONF:1198-28264).

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

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

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Functional Status Section (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.14:2014-06-09) (CONF:1198-28266).

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

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

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Discharge Diagnosis Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.24:2015-08-01) (CONF:1198-28272).

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

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

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

Base definition for all types defined in FHIR type system.

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

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

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

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

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Medical Equipment Section (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.23:2014-06-09) (CONF:1198-28276).

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

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

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

Base definition for all types defined in FHIR type system.

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

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

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

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

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Payers Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.18:2015-08-01) (CONF:1198-28280).

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

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

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

Base definition for all types defined in FHIR type system.

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

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

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

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

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

Base definition for all types defined in FHIR type system.

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

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

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

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

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Procedures Section (entries required) (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.7.1:2014-06-09) (CONF:1198-28286).

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

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

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

Base definition for all types defined in FHIR type system.

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

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

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

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

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Social History Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.17:2015-08-01) (CONF:1198-28290).

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

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

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:vitalSigns.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
210. ClinicalDocument.component.structuredBody.component:vitalSigns.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
211. ClinicalDocument.component.structuredBody.component:vitalSigns.section
Definition

Base definition for all types defined in FHIR type system.

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

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

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

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

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:mentalStatus.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
214. ClinicalDocument.component.structuredBody.component:mentalStatus.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
215. ClinicalDocument.component.structuredBody.component:mentalStatus.section
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Mental Status Section (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.56:2015-08-01) (CONF:1198-28328).

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

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

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:generalStatus.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
218. ClinicalDocument.component.structuredBody.component:generalStatus.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
219. ClinicalDocument.component.structuredBody.component:generalStatus.section
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] General Status Section (identifier: urn:oid:2.16.840.1.113883.10.20.2.5) (CONF:1198-28839).

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

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

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

Base definition for all types defined in FHIR type system.

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

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

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

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

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

Base definition for all types defined in FHIR type system.

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

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

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

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

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Reason for Referral Section (V2) (identifier: urn:hl7ii:1.3.6.1.4.1.19376.1.5.3.1.3.1:2014-06-09) (CONF:1198-31343).

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

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

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Past Medical History (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.20:2015-08-01) (CONF:1198-31562).

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

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

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] History of Present Illness Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.3.4) (CONF:1198-31564).

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

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

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

Base definition for all types defined in FHIR type system.

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

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

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

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

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Assessment Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.8) (CONF:1198-31568).

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

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

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Admission Medications Section (entries optional) (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.44:2015-08-01) (CONF:1198-32446).

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

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

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Admission Diagnosis Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.43:2015-08-01) (CONF:1198-32448).

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

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

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Course of Care Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.64) (CONF:1198-32649).

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-28239) such that it

InvariantsDefined on this element
1198-32946: 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-32946). (: )
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.13" (CONF:1198-28240).

Pattern Value2.16.840.1.113883.10.20.22.1.13
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-32907).

Pattern Value2015-08-01
18. 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). (: )
19. ClinicalDocument.code
Control1..1
BindingThe codes SHALL be taken from TransferDocumentType
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet TransferDocumentType http://hl7.org/fhir/ccda/ValueSet/2.16.840.1.113883.1.11.20.2.4 DYNAMIC (CONF:1198-28243).

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

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

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

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

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

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

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

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

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

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

28. 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.
29. 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
30. 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
31. 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
32. 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
33. 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
34. 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).

35. 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
36. 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
37. 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).

38. 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.
39. 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()))
40. 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).

41. 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.
42. ClinicalDocument.recordTarget.patientRole.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
43. 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.
44. 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).

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

46. 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
47. 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
48. 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
49. ClinicalDocument.recordTarget.patientRole.patient.id
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
50. 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()))
51. 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.
52. 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).

53. 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. (: )
54. 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.
55. 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.
56. 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.
57. 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.
58. 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).

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

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

61. 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). (: )
62. 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).

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

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

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

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

72. 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.
73. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
74. 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.
75. 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).

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

77. 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
78. 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
79. 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
80. 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()))
81. 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.
82. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
83. 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).

84. 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
85. 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
86. 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).

87. 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
88. 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
89. 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
90. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/EN
91. 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). (: )
92. 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.
93. 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.
94. 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.
95. 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()))
96. 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.
97. 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.
98. 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.
99. 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.
100. 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.
101. 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.
102. 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
103. 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
104. 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.
105. 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
106. 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
107. 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.
108. 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
109. 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()))
110. 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.
111. 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.
112. 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.
113. 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.
114. 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.
115. 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.
116. 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
117. 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
118. 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.
119. 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
120. 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
121. 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.
122. 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
123. 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()))
124. 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.
125. 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.
126. 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.
127. 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.
128. 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.
129. 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.
130. 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
131. 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
132. 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.
133. 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
134. 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
135. 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.
136. 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
137. 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()))
138. 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.
139. 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.
140. 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.
141. 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.
142. 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.
143. 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.
144. 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
145. 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
146. 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.
147. 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
148. 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
149. 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.
150. 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
151. 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()))
152. 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.
153. 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.
154. 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.
155. 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.
156. 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.
157. 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.
158. 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
159. 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
160. 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.
161. 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
162. 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
163. 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.
164. 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
165. 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()))
166. 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.
167. 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.
168. 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.
169. 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.
170. 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.
171. 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.
172. 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
173. 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
174. 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.
175. 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
176. 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
177. 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.
178. 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
179. 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()))
180. 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.
181. 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.
182. 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.
183. 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.
184. 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.
185. 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.
186. 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
187. 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
188. 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.
189. 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
190. 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
191. 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.
192. 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
193. 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()))
194. 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.
195. 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.
196. 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.
197. 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.
198. 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.
199. 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.
200. 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
201. 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
202. 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.
203. 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
204. 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
205. 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.
206. 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
207. 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()))
208. 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.
209. 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.
210. 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.
211. 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.
212. 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.
213. 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.
214. 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
215. 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
216. 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.
217. 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
218. 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
219. 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.
220. 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
221. 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()))
222. 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.
223. 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.
224. 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.
225. 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.
226. 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.
227. 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.
228. 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
229. 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
230. 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.
231. 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
232. 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
233. 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.
234. 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
235. 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()))
236. 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.
237. 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.
238. 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.
239. 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.
240. 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.
241. 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.
242. 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
243. 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
244. 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.
245. 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
246. 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
247. 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.
248. 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
249. 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()))
250. 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.
251. 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.
252. 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.
253. 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.
254. 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.
255. 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.
256. 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
257. 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
258. 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.
259. 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
260. 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
261. 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.
262. 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
263. 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()))
264. 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.
265. 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.
266. 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.
267. 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.
268. 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.
269. 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.
270. 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
271. 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
272. 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.
273. 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
274. 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
275. 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.
276. 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
277. 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()))
278. 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.
279. 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.
280. 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.
281. 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.
282. 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.
283. 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.
284. 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
285. 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
286. 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.
287. 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
288. 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
289. 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.
290. 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
291. 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()))
292. 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.
293. 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.
294. 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.
295. 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.
296. 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.
297. 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.
298. 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
299. 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
300. 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.
301. 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
302. 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
303. 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.
304. 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
305. 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()))
306. 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.
307. 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.
308. 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.
309. 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.
310. 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.
311. 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.
312. 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
313. 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
314. 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.
315. 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
316. 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
317. 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.
318. 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
319. 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()))
320. 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.
321. 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.
322. 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.
323. 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.
324. 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.
325. 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.
326. 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
327. 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
328. 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.
329. 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
330. 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
331. 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.
332. 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
333. 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()))
334. 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.
335. 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.
336. 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.
337. 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.
338. 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.
339. 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.
340. 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
341. 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
342. 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.
343. 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
344. 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
345. 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.
346. 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
347. 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()))
348. 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.
349. 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.
350. 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.
351. 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.
352. 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.
353. 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.
354. 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
355. 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
356. 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.
357. 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
358. 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
359. 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.
360. 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
361. 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()))
362. 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.
363. 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.
364. 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.
365. 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.
366. 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.
367. 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.
368. 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
369. 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
370. 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.
371. 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
372. 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
373. 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.
374. 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
375. 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()))
376. 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.
377. 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.
378. 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.
379. 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.
380. 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.
381. 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.
382. 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
383. 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
384. 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.
385. 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
386. 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
387. 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.
388. 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
389. 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()))
390. 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.
391. 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.
392. 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.
393. 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.
394. 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.
395. 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.
396. 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
397. 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
398. 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.
399. 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
400. 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
401. 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.
402. 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
403. 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()))
404. 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.
405. 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.
406. 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.
407. 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.
408. 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.
409. 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.
410. 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
411. 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
412. 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.
413. 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
414. 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
415. 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.
416. 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
417. 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()))
418. 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.
419. 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.
420. 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.
421. 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.
422. 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.
423. 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.
424. 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
425. 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
426. 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.
427. 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
428. 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
429. 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.
430. 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
431. 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()))
432. 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.
433. 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.
434. 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.
435. 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.
436. 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.
437. 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.
438. 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
439. 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
440. 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.
441. 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
442. 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
443. 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.
444. 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
445. 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()))
446. 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.
447. 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.
448. 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.
449. 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.
450. 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.
451. 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.
452. 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
453. 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
454. 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.
455. 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
456. 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
457. 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.
458. 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
459. 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()))
460. 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.
461. 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.
462. 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.
463. 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.
464. 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.
465. 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.
466. 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
467. 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
468. 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.
469. 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
470. 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
471. 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.
472. 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
473. 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.
474. 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.
475. 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).

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

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

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

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

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

482. 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
483. 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
484. 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
485. 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).

486. 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.
487. 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.
488. 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.
489. 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
490. 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.
491. 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).

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

493. 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.
494. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
495. 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.
496. 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).

497. 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()))
498. 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
499. ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/OrganizationPartOf
500. ClinicalDocument.author
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
Requirements

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

501. 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.
502. 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
503. 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
504. 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
505. 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
506. 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
507. ClinicalDocument.author.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
508. 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()))
509. 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). (: )
510. 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
511. 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
512. 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
513. 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

514. 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
515. 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.
516. 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.
517. 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
518. 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).

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

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

523. 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.
524. 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.
525. 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.
526. 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.
527. 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.
528. 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.
529. 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
530. 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
531. 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.
532. 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()))
533. 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).

534. 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.
535. ClinicalDocument.author.assignedAuthor.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
536. 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.
537. 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).

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

539. 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
540. 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
541. 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
542. 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()))
543. 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.
544. 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).

545. 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
546. 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
547. 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
548. 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
549. 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).

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

551. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/MaintainedEntity
552. ClinicalDocument.author.assignedAuthor.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
553. ClinicalDocument.dataEnterer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/DataEnterer
Requirements

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

554. 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.
555. 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
556. 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
557. 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
558. 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
559. 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
560. ClinicalDocument.dataEnterer.time
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
561. 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).

562. 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
563. 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
564. 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).

565. 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.
566. 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.
567. 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.
568. 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
569. 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.
570. 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.
571. 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).

572. 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()))
573. 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).

574. 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.
575. ClinicalDocument.dataEnterer.assignedEntity.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
576. 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.
577. 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).

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

579. 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
580. 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
581. 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
582. 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()))
583. 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.
584. ClinicalDocument.dataEnterer.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
585. 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
586. 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

587. 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.
588. 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
589. 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
590. 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
591. 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
592. 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
593. ClinicalDocument.informant:informant1.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

594. 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
595. 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
596. 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). (: )
597. 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.
598. 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).

599. 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()))
600. ClinicalDocument.informant:informant1.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
601. 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).

602. 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
603. 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
604. 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
605. 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()))
606. 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.
607. ClinicalDocument.informant:informant1.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
608. ClinicalDocument.informant:informant1.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
609. 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

610. 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.
611. 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
612. 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
613. 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
614. 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
615. 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
616. ClinicalDocument.informant:informant2.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
617. ClinicalDocument.informant:informant2.relatedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
Requirements

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

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

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

619. 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.
620. 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
621. 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
622. 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
623. 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
624. 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).

625. 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
626. 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
627. 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).

628. 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
629. 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
630. 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
631. 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).

632. 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.
633. 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.
634. 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.
635. 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
636. 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.
637. 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).

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

639. 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.
640. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
641. 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.
642. 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).

643. 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()))
644. ClinicalDocument.informationRecipient
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/InformationRecipient
Requirements

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

645. 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.
646. 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
647. 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
648. 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
649. 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
650. 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).

651. ClinicalDocument.informationRecipient.intendedRecipient.classCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
652. 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
653. 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).

654. 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.
655. ClinicalDocument.informationRecipient.intendedRecipient.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
656. ClinicalDocument.informationRecipient.intendedRecipient.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
657. 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).

658. 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
659. 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
660. 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
661. 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()))
662. 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.
663. 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).

664. 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
665. 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
666. 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
667. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
668. 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).

669. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
670. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
671. 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
672. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/OrganizationPartOf
673. ClinicalDocument.legalAuthenticator
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/LegalAuthenticator
Requirements

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

674. 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.
675. 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
676. 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
677. 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
678. 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
679. 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
680. 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()))
681. 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).

682. 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.
683. 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
684. 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.
685. 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.
686. 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.
687. 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.
688. 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.
689. 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.
690. 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
691. 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
692. 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.
693. 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.
694. 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).

695. 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
696. 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
697. 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).

698. 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.
699. 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.
700. 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.
701. 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
702. 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.
703. 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.
704. 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).

705. 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()))
706. 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).

707. 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.
708. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
709. 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.
710. 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).

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

712. 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
713. 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
714. 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
715. 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()))
716. 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.
717. ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
718. 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,
719. 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

720. 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.
721. 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
722. 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
723. 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
724. 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
725. 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()))
726. ClinicalDocument.authenticator:authenticator1.signatureCode
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

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

727. 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.
728. 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
729. 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.
730. 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.
731. 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.
732. 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.
733. 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.
734. 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.
735. 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
736. 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
737. 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.
738. 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.
739. ClinicalDocument.authenticator:authenticator1.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

740. 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
741. 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
742. 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).

743. 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.
744. 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.
745. 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.
746. 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
747. 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.
748. 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.
749. 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).

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

752. 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.
753. 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.
754. 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.
755. 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.
756. 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.
757. 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.
758. 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
759. 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
760. 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.
761. 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()))
762. 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).

763. 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.
764. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
765. 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.
766. 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).

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

768. 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
769. 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
770. 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
771. 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()))
772. 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.
773. ClinicalDocument.authenticator:authenticator1.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
774. 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
775. ClinicalDocument.participant:participant1
SliceNameparticipant1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant1
Requirements

SHOULD contain zero or more [0..*] participant (CONF:1198-31599) 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). (: )
776. 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.
777. 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="IND" indirect (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:1198-31872).

Pattern ValueIND
778. 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
779. 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
780. 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
781. 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
782. ClinicalDocument.participant:participant1.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
783. ClinicalDocument.participant:participant1.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

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

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

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

785. ClinicalDocument.participant:participant1.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 DYNAMIC (CONF:1198-31873).

786. 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
787. ClinicalDocument.participant:participant1.associatedEntity.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
788. 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.
789. 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
790. ClinicalDocument.participant:participant1.associatedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
791. ClinicalDocument.participant:participant1.associatedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
792. ClinicalDocument.participant:participant1.associatedEntity.associatedPerson
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
Requirements

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

793. ClinicalDocument.participant:participant1.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
794. ClinicalDocument.participant:participant1.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
795. ClinicalDocument.participant:participant1.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
796. ClinicalDocument.participant:participant1.associatedEntity.associatedPerson.name
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/EN
Requirements

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

797. ClinicalDocument.participant:participant1.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.
798. ClinicalDocument.participant:participant1.associatedEntity.scopingOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
799. ClinicalDocument.participant:participant2
SliceNameparticipant2
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant1
Requirements

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

800. 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.
801. 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="CALLBCK" Call back contact (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:1198-31627).

Pattern ValueCALLBCK
802. 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
803. 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
804. 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
805. 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
806. ClinicalDocument.participant:participant2.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
807. ClinicalDocument.participant:participant2.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
808. ClinicalDocument.participant:participant2.associatedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssociatedEntity
Requirements

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

809. ClinicalDocument.participant:participant2.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" assigned entity (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110) (CONF:1198-31641).

Pattern ValueASSIGNED
810. 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
811. ClinicalDocument.participant:participant2.associatedEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

812. 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.
813. 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
814. ClinicalDocument.participant:participant2.associatedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
Requirements

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

815. ClinicalDocument.participant:participant2.associatedEntity.telecom
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Requirements

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

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

817. 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
818. 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
819. 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
820. 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-31633).

821. 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.
822. ClinicalDocument.participant:participant2.associatedEntity.scopingOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
Requirements

This associatedEntity MAY contain zero or one [0..1] scopingOrganization (CONF:1198-31634).

823. ClinicalDocument.inFulfillmentOf
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/InFulfillmentOf
Requirements

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

824. 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.
825. 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
826. 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
827. 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
828. 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
829. 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).

830. 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
831. 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
832. 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
833. 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).

834. 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
835. 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
836. ClinicalDocument.documentationOf
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/DocumentationOf
Requirements

SHALL contain exactly one [1..1] documentationOf (CONF:1198-31570).

837. 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.
838. 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
839. 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
840. 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
841. 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
842. ClinicalDocument.documentationOf.serviceEvent
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ServiceEvent
Requirements

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

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

Default ValueACT
Pattern ValuePCPR
844. 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
845. 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
846. ClinicalDocument.documentationOf.serviceEvent.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
847. ClinicalDocument.documentationOf.serviceEvent.code
Definition

Drawn from concept domain ActCode

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

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

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

849. 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.
850. 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.
851. 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.
852. 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.
853. 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).

854. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
Definition

This is the high limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
855. 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
856. 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
857. 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).

SlicingThis element introduces a set of slices on ClinicalDocument.documentationOf.serviceEvent.performer. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
858. 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.
859. 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
860. 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
861. 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
862. 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
863. 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).

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

866. 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.
867. 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.
868. 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.
869. 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.
870. 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.
871. 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.
872. 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
873. 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
874. 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.
875. ClinicalDocument.documentationOf.serviceEvent.performer.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
876. 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).

877. 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
878. 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
879. 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).

880. 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.
881. 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.
882. 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.
883. 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
884. 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.
885. 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.
886. 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).

887. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
888. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
889. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
890. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
891. ClinicalDocument.documentationOf.serviceEvent.performer:performer1
SliceNameperformer1
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer1
Requirements

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

892. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.nullFlavor
Definition

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

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

SHALL contain exactly one [1..1] @typeCode="PRF" Participation of Physical Performer (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 DYNAMIC) (CONF:1198-31575).

Fixed ValueDOC
Pattern ValuePRF
894. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.realmCode
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
895. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.typeId
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
896. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.templateId
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
897. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode
Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

898. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
899. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.code
Definition

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

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

900. ClinicalDocument.documentationOf.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.
901. ClinicalDocument.documentationOf.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.
902. ClinicalDocument.documentationOf.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.
903. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.displayName
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
904. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.sdtcValueSet
Definition

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

Control0..1
Typestring
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.
905. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.sdtcValueSetVersion
Definition

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

Control0..1
Typestring
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.
906. ClinicalDocument.documentationOf.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
907. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
908. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.translation
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
909. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
910. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.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).

911. ClinicalDocument.documentationOf.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
912. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.templateId
Definition

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

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

914. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.id.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
915. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.id.assigningAuthorityName
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
916. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.id.displayable
Definition

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

Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
917. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.id.root
Definition

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

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
918. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.id.extension
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
919. ClinicalDocument.documentationOf.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.
920. ClinicalDocument.documentationOf.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 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).

921. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
922. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
923. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.assignedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
924. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
925. ClinicalDocument.relatedDocument
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedDocument
926. 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
927. 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

928. 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.
929. 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
930. 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
931. 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
932. 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
933. ClinicalDocument.authorization:authorization1.consent
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Consent
Requirements

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

934. 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
935. 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
936. 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
937. 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).

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

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

940. 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
941. ClinicalDocument.componentOf
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ComponentOf
Requirements

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

942. ClinicalDocument.componentOf.nullFlavor
Definition

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

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

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

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

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

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

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

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

The componentOf, if present, SHALL contain exactly one [1..1] encompassingEncounter (CONF:1198-9956).

948. ClinicalDocument.componentOf.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
949. ClinicalDocument.componentOf.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
950. ClinicalDocument.componentOf.encompassingEncounter.templateId
Definition

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

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

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

952. ClinicalDocument.componentOf.encompassingEncounter.code
Control0..1
BindingThe codes SHALL be taken from ActEncounterCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
953. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

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

954. ClinicalDocument.componentOf.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.
955. ClinicalDocument.componentOf.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
956. ClinicalDocument.componentOf.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()))
957. ClinicalDocument.componentOf.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
958. ClinicalDocument.componentOf.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
959. ClinicalDocument.componentOf.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
960. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
961. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/EncounterParticipant
962. ClinicalDocument.componentOf.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()))
963. ClinicalDocument.componentOf.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
964. ClinicalDocument.componentOf.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
965. ClinicalDocument.componentOf.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
966. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/HealthCareFacility
967. ClinicalDocument.component
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Component2
Requirements

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

968. 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.
969. 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
970. ClinicalDocument.component.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
971. 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
972. 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
973. 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
974. ClinicalDocument.component.nonXMLBody
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/NonXMLBody
975. ClinicalDocument.component.structuredBody
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/StructuredBody
Requirements

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

InvariantsDefined on this element
1198-31582: This structuredBody **SHALL** contain an Assessment and Plan Section (V2) (2.16.840.1.113883.10.20.22.2.9:2014-06-09), or an Assessment Section (2.16.840.1.113883.10.20.22.2.8) and a Plan of Treatment Section (V2) (2.16.840.1.113883.10.20.22.2.10:2014-06-09) (CONF:1198-31582). (: )
1198-31583: This structuredBody **SHALL NOT** contain an Assessment and Plan Section (V2) (2.16.840.1.113883.10.20.22.2.9:2014-06-09) when either an Assessment Section (2.16.840.1.113883.10.20.22.2.8) or a Plan of Treatment Section (V2) (2.16.840.1.113883.10.20.22.2.10:2014-06-09) is present (CONF:1198-31583). (: )
976. 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
977. 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
978. ClinicalDocument.component.structuredBody.confidentialityCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
979. ClinicalDocument.component.structuredBody.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
980. ClinicalDocument.component.structuredBody.component
Control0..1
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 @ section.code
981. 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
982. 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
983. ClinicalDocument.component.structuredBody.component.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
984. ClinicalDocument.component.structuredBody.component.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
985. ClinicalDocument.component.structuredBody.component.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section
986. ClinicalDocument.component.structuredBody.component:advanceDirectives
SliceNameadvanceDirectives
Control0..1
TypeElement
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
987. ClinicalDocument.component.structuredBody.component:advanceDirectives.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
988. ClinicalDocument.component.structuredBody.component:advanceDirectives.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
989. ClinicalDocument.component.structuredBody.component:advanceDirectives.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
990. ClinicalDocument.component.structuredBody.component:advanceDirectives.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
991. ClinicalDocument.component.structuredBody.component:advanceDirectives.section
Definition

Base definition for all types defined in FHIR type system.

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

The component, if present, SHALL contain exactly one [1..1] Advance Directives Section (entries required) (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.21.1:2015-08-01) (CONF:1198-28254).

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
993. ClinicalDocument.component.structuredBody.component:allergiesAndIntolerances.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
994. ClinicalDocument.component.structuredBody.component:allergiesAndIntolerances.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
995. ClinicalDocument.component.structuredBody.component:allergiesAndIntolerances.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
996. ClinicalDocument.component.structuredBody.component:allergiesAndIntolerances.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
997. ClinicalDocument.component.structuredBody.component:allergiesAndIntolerances.section
Definition

Base definition for all types defined in FHIR type system.

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

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

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
999. ClinicalDocument.component.structuredBody.component:physicalExam.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
1000. ClinicalDocument.component.structuredBody.component:physicalExam.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
1001. ClinicalDocument.component.structuredBody.component:physicalExam.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1002. ClinicalDocument.component.structuredBody.component:physicalExam.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1003. ClinicalDocument.component.structuredBody.component:physicalExam.section
Definition

Base definition for all types defined in FHIR type system.

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

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

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1005. ClinicalDocument.component.structuredBody.component:encounters.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
1006. ClinicalDocument.component.structuredBody.component:encounters.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
1007. ClinicalDocument.component.structuredBody.component:encounters.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1008. ClinicalDocument.component.structuredBody.component:encounters.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1009. ClinicalDocument.component.structuredBody.component:encounters.section
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Encounters Section (entries required) (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.22.1:2015-08-01) (CONF:1198-28262).

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1011. ClinicalDocument.component.structuredBody.component:familyHistory.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
1012. ClinicalDocument.component.structuredBody.component:familyHistory.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
1013. ClinicalDocument.component.structuredBody.component:familyHistory.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1014. ClinicalDocument.component.structuredBody.component:familyHistory.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1015. ClinicalDocument.component.structuredBody.component:familyHistory.section
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Family History Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.15:2015-08-01) (CONF:1198-28264).

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1017. ClinicalDocument.component.structuredBody.component:functionalStatus.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
1018. ClinicalDocument.component.structuredBody.component:functionalStatus.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
1019. ClinicalDocument.component.structuredBody.component:functionalStatus.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1020. ClinicalDocument.component.structuredBody.component:functionalStatus.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1021. ClinicalDocument.component.structuredBody.component:functionalStatus.section
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Functional Status Section (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.14:2014-06-09) (CONF:1198-28266).

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1023. ClinicalDocument.component.structuredBody.component:dischargeDiagnosis.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
1024. ClinicalDocument.component.structuredBody.component:dischargeDiagnosis.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
1025. ClinicalDocument.component.structuredBody.component:dischargeDiagnosis.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1026. ClinicalDocument.component.structuredBody.component:dischargeDiagnosis.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1027. ClinicalDocument.component.structuredBody.component:dischargeDiagnosis.section
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Discharge Diagnosis Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.24:2015-08-01) (CONF:1198-28272).

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1029. ClinicalDocument.component.structuredBody.component:immunizations.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
1030. ClinicalDocument.component.structuredBody.component:immunizations.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
1031. ClinicalDocument.component.structuredBody.component:immunizations.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1032. ClinicalDocument.component.structuredBody.component:immunizations.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1033. ClinicalDocument.component.structuredBody.component:immunizations.section
Definition

Base definition for all types defined in FHIR type system.

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

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

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1035. ClinicalDocument.component.structuredBody.component:medicalEquip.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
1036. ClinicalDocument.component.structuredBody.component:medicalEquip.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
1037. ClinicalDocument.component.structuredBody.component:medicalEquip.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1038. ClinicalDocument.component.structuredBody.component:medicalEquip.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1039. ClinicalDocument.component.structuredBody.component:medicalEquip.section
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Medical Equipment Section (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.23:2014-06-09) (CONF:1198-28276).

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1041. ClinicalDocument.component.structuredBody.component:medications.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
1042. ClinicalDocument.component.structuredBody.component:medications.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
1043. ClinicalDocument.component.structuredBody.component:medications.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1044. ClinicalDocument.component.structuredBody.component:medications.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1045. ClinicalDocument.component.structuredBody.component:medications.section
Definition

Base definition for all types defined in FHIR type system.

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

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

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1047. ClinicalDocument.component.structuredBody.component:payers.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
1048. ClinicalDocument.component.structuredBody.component:payers.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
1049. ClinicalDocument.component.structuredBody.component:payers.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1050. ClinicalDocument.component.structuredBody.component:payers.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1051. ClinicalDocument.component.structuredBody.component:payers.section
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Payers Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.18:2015-08-01) (CONF:1198-28280).

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1053. ClinicalDocument.component.structuredBody.component:planOfTreatment.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
1054. ClinicalDocument.component.structuredBody.component:planOfTreatment.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
1055. ClinicalDocument.component.structuredBody.component:planOfTreatment.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1056. ClinicalDocument.component.structuredBody.component:planOfTreatment.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1057. ClinicalDocument.component.structuredBody.component:planOfTreatment.section
Definition

Base definition for all types defined in FHIR type system.

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

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

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1059. ClinicalDocument.component.structuredBody.component:problem.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
1060. ClinicalDocument.component.structuredBody.component:problem.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
1061. ClinicalDocument.component.structuredBody.component:problem.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1062. ClinicalDocument.component.structuredBody.component:problem.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1063. ClinicalDocument.component.structuredBody.component:problem.section
Definition

Base definition for all types defined in FHIR type system.

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

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

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1065. ClinicalDocument.component.structuredBody.component:procedures.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
1066. ClinicalDocument.component.structuredBody.component:procedures.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
1067. ClinicalDocument.component.structuredBody.component:procedures.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1068. ClinicalDocument.component.structuredBody.component:procedures.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1069. ClinicalDocument.component.structuredBody.component:procedures.section
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Procedures Section (entries required) (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.7.1:2014-06-09) (CONF:1198-28286).

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1071. ClinicalDocument.component.structuredBody.component:results.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
1072. ClinicalDocument.component.structuredBody.component:results.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
1073. ClinicalDocument.component.structuredBody.component:results.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1074. ClinicalDocument.component.structuredBody.component:results.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1075. ClinicalDocument.component.structuredBody.component:results.section
Definition

Base definition for all types defined in FHIR type system.

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

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

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1077. ClinicalDocument.component.structuredBody.component:socialHistory.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
1078. ClinicalDocument.component.structuredBody.component:socialHistory.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
1079. ClinicalDocument.component.structuredBody.component:socialHistory.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1080. ClinicalDocument.component.structuredBody.component:socialHistory.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1081. ClinicalDocument.component.structuredBody.component:socialHistory.section
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Social History Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.17:2015-08-01) (CONF:1198-28290).

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1083. ClinicalDocument.component.structuredBody.component:vitalSigns.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
1084. ClinicalDocument.component.structuredBody.component:vitalSigns.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
1085. ClinicalDocument.component.structuredBody.component:vitalSigns.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1086. ClinicalDocument.component.structuredBody.component:vitalSigns.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1087. ClinicalDocument.component.structuredBody.component:vitalSigns.section
Definition

Base definition for all types defined in FHIR type system.

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

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

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1089. ClinicalDocument.component.structuredBody.component:mentalStatus.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
1090. ClinicalDocument.component.structuredBody.component:mentalStatus.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
1091. ClinicalDocument.component.structuredBody.component:mentalStatus.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1092. ClinicalDocument.component.structuredBody.component:mentalStatus.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1093. ClinicalDocument.component.structuredBody.component:mentalStatus.section
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Mental Status Section (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.56:2015-08-01) (CONF:1198-28328).

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1095. ClinicalDocument.component.structuredBody.component:generalStatus.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
1096. ClinicalDocument.component.structuredBody.component:generalStatus.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
1097. ClinicalDocument.component.structuredBody.component:generalStatus.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1098. ClinicalDocument.component.structuredBody.component:generalStatus.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1099. ClinicalDocument.component.structuredBody.component:generalStatus.section
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] General Status Section (identifier: urn:oid:2.16.840.1.113883.10.20.2.5) (CONF:1198-28839).

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1101. ClinicalDocument.component.structuredBody.component:reviewOfSystems.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
1102. ClinicalDocument.component.structuredBody.component:reviewOfSystems.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
1103. ClinicalDocument.component.structuredBody.component:reviewOfSystems.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1104. ClinicalDocument.component.structuredBody.component:reviewOfSystems.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1105. ClinicalDocument.component.structuredBody.component:reviewOfSystems.section
Definition

Base definition for all types defined in FHIR type system.

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

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

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1107. ClinicalDocument.component.structuredBody.component:nutrition.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
1108. ClinicalDocument.component.structuredBody.component:nutrition.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
1109. ClinicalDocument.component.structuredBody.component:nutrition.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1110. ClinicalDocument.component.structuredBody.component:nutrition.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1111. ClinicalDocument.component.structuredBody.component:nutrition.section
Definition

Base definition for all types defined in FHIR type system.

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

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

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1113. ClinicalDocument.component.structuredBody.component:reasonForReferral.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
1114. ClinicalDocument.component.structuredBody.component:reasonForReferral.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
1115. ClinicalDocument.component.structuredBody.component:reasonForReferral.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1116. ClinicalDocument.component.structuredBody.component:reasonForReferral.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1117. ClinicalDocument.component.structuredBody.component:reasonForReferral.section
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Reason for Referral Section (V2) (identifier: urn:hl7ii:1.3.6.1.4.1.19376.1.5.3.1.3.1:2014-06-09) (CONF:1198-31343).

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1119. ClinicalDocument.component.structuredBody.component:pastMedicalHistory.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
1120. ClinicalDocument.component.structuredBody.component:pastMedicalHistory.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
1121. ClinicalDocument.component.structuredBody.component:pastMedicalHistory.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1122. ClinicalDocument.component.structuredBody.component:pastMedicalHistory.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1123. ClinicalDocument.component.structuredBody.component:pastMedicalHistory.section
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Past Medical History (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.20:2015-08-01) (CONF:1198-31562).

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1125. ClinicalDocument.component.structuredBody.component:historyOfPresentIllness.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.component.structuredBody.component:historyOfPresentIllness.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
1127. ClinicalDocument.component.structuredBody.component:historyOfPresentIllness.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1128. ClinicalDocument.component.structuredBody.component:historyOfPresentIllness.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1129. ClinicalDocument.component.structuredBody.component:historyOfPresentIllness.section
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] History of Present Illness Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.3.4) (CONF:1198-31564).

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1131. ClinicalDocument.component.structuredBody.component:assessmentAndPlan.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.component.structuredBody.component:assessmentAndPlan.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
1133. ClinicalDocument.component.structuredBody.component:assessmentAndPlan.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1134. ClinicalDocument.component.structuredBody.component:assessmentAndPlan.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1135. ClinicalDocument.component.structuredBody.component:assessmentAndPlan.section
Definition

Base definition for all types defined in FHIR type system.

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

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

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1137. ClinicalDocument.component.structuredBody.component:assessment.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
1138. ClinicalDocument.component.structuredBody.component:assessment.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
1139. ClinicalDocument.component.structuredBody.component:assessment.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1140. ClinicalDocument.component.structuredBody.component:assessment.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1141. ClinicalDocument.component.structuredBody.component:assessment.section
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Assessment Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.8) (CONF:1198-31568).

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1143. ClinicalDocument.component.structuredBody.component:admissionMedications.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
1144. ClinicalDocument.component.structuredBody.component:admissionMedications.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
1145. ClinicalDocument.component.structuredBody.component:admissionMedications.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1146. ClinicalDocument.component.structuredBody.component:admissionMedications.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1147. ClinicalDocument.component.structuredBody.component:admissionMedications.section
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Admission Medications Section (entries optional) (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.44:2015-08-01) (CONF:1198-32446).

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1149. ClinicalDocument.component.structuredBody.component:admissionDiagnosis.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:admissionDiagnosis.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:admissionDiagnosis.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:admissionDiagnosis.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1153. ClinicalDocument.component.structuredBody.component:admissionDiagnosis.section
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Admission Diagnosis Section (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.43:2015-08-01) (CONF:1198-32448).

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

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

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:courseOfCare.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:courseOfCare.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:courseOfCare.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:courseOfCare.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1159. ClinicalDocument.component.structuredBody.component:courseOfCare.section
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Course of Care Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.64) (CONF:1198-32649).

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