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

Active as of 2023-01-16

Definitions for the 2.16.840.1.113883.10.20.22.1.2 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-8450) such that it

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

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

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

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

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

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

6. ClinicalDocument.code
Requirements

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

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

7. ClinicalDocument.code.code
Control1..1
Requirements

This code SHALL contain exactly one [1..1] @code="34133-9" Summarization of Episode Note (CONF:1198-17181).

Pattern Value34133-9
8. ClinicalDocument.code.codeSystem
Control1..1
Requirements

This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:1198-32138).

Pattern Value2.16.840.1.113883.6.1
9. ClinicalDocument.author
Requirements

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

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

10. ClinicalDocument.author.assignedAuthor
Requirements

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

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

InvariantsDefined on this element
1198-8456: Such assignedAuthors **SHALL** contain (exactly one [1..1] assignedPerson) or (exactly one [1..1] assignedAuthoringDevice and exactly one [1..1] representedOrganization) (CONF:1198-8456). (: null)
1198-8457: If assignedAuthor has an associated representedOrganization with no assignedPerson or assignedAuthoringDevice, then the value for “ClinicalDocument/author/assignedAuthor/id/@NullFlavor” **SHALL** be “NA” “Not applicable” 2.16.840.1.113883.5.1008 NullFlavor STATIC (CONF:1198-8457). (: null)
11. ClinicalDocument.documentationOf
Control10..1*
Requirements

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

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

12. ClinicalDocument.documentationOf.serviceEvent
Requirements

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

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

13. 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 STATIC) (CONF:1198-8453).

Pattern ValuePCPR
14. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Requirements

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

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

15. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low
Requirements

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

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

16. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
Control10..1
Requirements

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

17. ClinicalDocument.documentationOf.serviceEvent.performer
Requirements

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

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

18. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode
Requirements

The performer, if present, SHALL contain exactly one [1..1] @typeCode="PRF" Participation physical performer (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8458).

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

Pattern ValuePRF
19. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Requirements

The performer, if present, MAY contain zero or one [0..1] assignedEntity (CONF:1198-8459).

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

20. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
SlicingThis element introduces a set of slices on ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id. The slices are unordered and Open, and defines no discriminators to differentiate the slices
21. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id:id1
SliceNameid1
Control1..*
Requirements

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

InvariantsDefined on this element
1198-32466: If this assignedEntity is an assignedPerson, the assignedEntity/id **SHOULD** contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-32466). (: null)
22. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Requirements

The assignedEntity, if present, MAY contain zero or one [0..1] assignedPerson (CONF:1198-32467).

23. ClinicalDocument.component
Requirements

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

24. ClinicalDocument.component.structuredBody
Control1..1
Requirements

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

25. ClinicalDocument.component.structuredBody.component
Control0..?
SlicingThis element introduces a set of slices on ClinicalDocument.component.structuredBody.component. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ section
26. ClinicalDocument.component.structuredBody.component:allergies
SliceNameallergies
Control1..1
Requirements

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

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

This component 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-30662).

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

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

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

30. ClinicalDocument.component.structuredBody.component:problems
SliceNameproblems
Control1..1
Requirements

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

31. ClinicalDocument.component.structuredBody.component:problems.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-30666).

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

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

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

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

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

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

36. ClinicalDocument.component.structuredBody.component:advDirectives
SliceNameadvDirectives
Control0..1
Requirements

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

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

SHALL contain exactly one [1..1] Advance Directives Section (entries optional) (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.21:2015-08-01) (CONF:1198-30672).

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

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

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

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

40. ClinicalDocument.component.structuredBody.component:famHistory
SliceNamefamHistory
Control0..1
Requirements

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

41. ClinicalDocument.component.structuredBody.component:famHistory.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-30676).

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

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

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

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

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

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

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

46. ClinicalDocument.component.structuredBody.component:medEquipment
SliceNamemedEquipment
Control0..1
Requirements

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

47. ClinicalDocument.component.structuredBody.component:medEquipment.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-30682).

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

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

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

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

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

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

52. ClinicalDocument.component.structuredBody.component:socialHist
SliceNamesocialHist
Control1..1
Requirements

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

53. ClinicalDocument.component.structuredBody.component:socialHist.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-30688).

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

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

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

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

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

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

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

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

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

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

InvariantsDefined on this element
1198-32936: 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-32936). (: 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.2" (CONF:1198-10038).

Pattern Value2.16.840.1.113883.10.20.22.1.2
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-32516).

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 FHIRDocumentTypeCodes; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

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.code.code
Definition

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

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

This code SHALL contain exactly one [1..1] @code="34133-9" Summarization of Episode Note (CONF:1198-17181).

Pattern Value34133-9
15. ClinicalDocument.code.codeSystem
Definition

Specifies the code system that defines the code.

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

This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:1198-32138).

Pattern Value2.16.840.1.113883.6.1
16. ClinicalDocument.code.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
17. ClinicalDocument.title
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ST
Requirements

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

37. 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()))
38. ClinicalDocument.author.assignedAuthor
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedAuthor
Requirements

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

InvariantsDefined on this element
1198-8456: Such assignedAuthors **SHALL** contain (exactly one [1..1] assignedPerson) or (exactly one [1..1] assignedAuthoringDevice and exactly one [1..1] representedOrganization) (CONF:1198-8456). (: null)
1198-8457: If assignedAuthor has an associated representedOrganization with no assignedPerson or assignedAuthoringDevice, then the value for “ClinicalDocument/author/assignedAuthor/id/@NullFlavor” **SHALL** be “NA” “Not applicable” 2.16.840.1.113883.5.1008 NullFlavor STATIC (CONF:1198-8457). (: null)
1198-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:1198-16790). (: null)
39. 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
40. 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
41. 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

42. 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
43. 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()))
44. 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).

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

46. 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
47. 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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

68. 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()))
69. 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,
70. 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

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

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

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

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

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

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

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

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

88. 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
89. 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
90. 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()))
91. ClinicalDocument.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant1
SlicingThis element introduces a set of slices on ClinicalDocument.participant. The slices are unordered and Open, and defines no discriminators to differentiate the slices
92. ClinicalDocument.participant:participant1
SliceNameparticipant1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant1
Requirements

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

InvariantsDefined on this element
1198-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:1198-10006). (: 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)
93. ClinicalDocument.participant:participant1.associatedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssociatedEntity
94. ClinicalDocument.documentationOf
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/DocumentationOf
Requirements

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

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

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

96. 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 STATIC) (CONF:1198-8453).

Default ValueACT
Pattern ValuePCPR
97. 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
98. 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-8481).

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

100. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
Definition

This is the high limit of the interval.

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

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

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

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

102. 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="PRF" Participation physical performer (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8458).

Fixed ValueDOC
Pattern ValuePRF
103. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

The performer, if present, MAY contain zero or one [0..1] assignedEntity (CONF:1198-8459).

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

SlicingThis element introduces a set of slices on ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id. The slices are unordered and Open, and defines no discriminators to differentiate the slices
106. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id:id1
SliceNameid1
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

InvariantsDefined on this element
1198-32466: If this assignedEntity is an assignedPerson, the assignedEntity/id **SHOULD** contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-32466). (: null)
107. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
Requirements

The assignedEntity, if present, MAY contain zero or one [0..1] assignedPerson (CONF:1198-32467).

108. 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
109. 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

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

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

111. 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
112. 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
113. 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).

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

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

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

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

118. 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
119. 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
120. ClinicalDocument.component.structuredBody.component
Control1..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on ClinicalDocument.component.structuredBody.component. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ section
121. ClinicalDocument.component.structuredBody.component.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
122. ClinicalDocument.component.structuredBody.component.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
123. ClinicalDocument.component.structuredBody.component.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section
124. ClinicalDocument.component.structuredBody.component:allergies
SliceNameallergies
Control1..1
TypeElement
Requirements

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

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

Base definition for all types defined in FHIR type system.

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

This component 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-30662).

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Advance Directives Section (entries optional) (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.21:2015-08-01) (CONF:1198-30672).

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:encounters
SliceNameencounters
Control0..1
TypeElement
Requirements

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30673) 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:encounters.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:encounters.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
151. 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(EncountersSectionentriesoptional)
Requirements

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

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:famHistory
SliceNamefamHistory
Control0..1
TypeElement
Requirements

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30675) 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:famHistory.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:famHistory.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
155. ClinicalDocument.component.structuredBody.component:famHistory.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-30676).

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:functionalStatus
SliceNamefunctionalStatus
Control0..1
TypeElement
Requirements

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30677) 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:functionalStatus.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:functionalStatus.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
159. 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-30678).

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:immunizations
SliceNameimmunizations
Control0..1
TypeElement
Requirements

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30679) 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:immunizations.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:immunizations.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
163. 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(ImmunizationsSectionEntriesRequired)
Requirements

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

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:medEquipment
SliceNamemedEquipment
Control0..1
TypeElement
Requirements

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30681) 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:medEquipment.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:medEquipment.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
167. ClinicalDocument.component.structuredBody.component:medEquipment.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-30682).

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:payers
SliceNamepayers
Control0..1
TypeElement
Requirements

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30683) 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:payers.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:payers.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
171. 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-30684).

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:planOfTreatment
SliceNameplanOfTreatment
Control0..1
TypeElement
Requirements

This structuredBody SHOULD contain zero or one [0..1] component (CONF:1198-30685) 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:planOfTreatment.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:planOfTreatment.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
175. 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-30686).

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:socialHist
SliceNamesocialHist
Control1..1
TypeElement
Requirements

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30687) 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:socialHist.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:socialHist.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
179. ClinicalDocument.component.structuredBody.component:socialHist.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-30688).

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:vitalSigns
SliceNamevitalSigns
Control1..1
TypeElement
Requirements

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30689) 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:vitalSigns.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:vitalSigns.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
183. 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-30690).

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:mentalStatus
SliceNamementalStatus
Control0..1
TypeElement
Requirements

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-32143) 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:mentalStatus.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:mentalStatus.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
187. 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-32144).

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:nutrition
SliceNamenutrition
Control0..1
TypeElement
Requirements

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-32624) 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:nutrition.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:nutrition.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
191. 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-32625).

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

InvariantsDefined on this element
1198-32936: 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-32936). (: )
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.2" (CONF:1198-10038).

Pattern Value2.16.840.1.113883.10.20.22.1.2
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-32516).

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 FHIRDocumentTypeCodes; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

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

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.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.
21. ClinicalDocument.code.code
Definition

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

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

This code SHALL contain exactly one [1..1] @code="34133-9" Summarization of Episode Note (CONF:1198-17181).

Pattern Value34133-9
22. ClinicalDocument.code.codeSystem
Definition

Specifies the code system that defines the code.

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

This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:1198-32138).

Pattern Value2.16.840.1.113883.6.1
23. ClinicalDocument.code.codeSystemName
Definition

The common name of the coding system.

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

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

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

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

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

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet.
27. ClinicalDocument.code.sdtcValueSetVersion
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion.
28. ClinicalDocument.code.originalText
Definition

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

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

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

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

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
31. ClinicalDocument.title
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ST
Requirements

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

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

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

35. 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). (: )
36. 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). (: )
37. ClinicalDocument.copyTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
38. ClinicalDocument.recordTarget
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/RecordTarget
Requirements

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

39. 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.
40. 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
41. 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
42. 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
43. 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
44. 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
45. 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).

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

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

52. 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.
53. ClinicalDocument.recordTarget.patientRole.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
54. 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.
55. 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).

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

57. 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
58. 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
59. 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
60. ClinicalDocument.recordTarget.patientRole.patient.id
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
61. 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()))
62. 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.
63. 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).

64. 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. (: )
65. 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.
66. 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.
67. 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.
68. 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.
69. 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).

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

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

72. 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). (: )
73. 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).

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

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

76. 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
77. 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
78. ClinicalDocument.recordTarget.patientRole.patient.guardian.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
79. 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.
80. 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).

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

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

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

88. 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
89. 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
90. 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
91. 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()))
92. 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.
93. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
94. 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).

95. 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
96. 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
97. 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).

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

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

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

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

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

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

493. 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
494. 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
495. 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
496. 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).

497. 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.
498. 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.
499. 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.
500. 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
501. 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.
502. 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).

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

504. 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.
505. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
506. 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.
507. 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).

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

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

512. 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.
513. 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
514. 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
515. 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
516. 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
517. 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
518. ClinicalDocument.author.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
519. 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()))
520. ClinicalDocument.author.assignedAuthor
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedAuthor
Requirements

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

InvariantsDefined on this element
1198-8456: Such assignedAuthors **SHALL** contain (exactly one [1..1] assignedPerson) or (exactly one [1..1] assignedAuthoringDevice and exactly one [1..1] representedOrganization) (CONF:1198-8456). (: )
1198-8457: If assignedAuthor has an associated representedOrganization with no assignedPerson or assignedAuthoringDevice, then the value for “ClinicalDocument/author/assignedAuthor/id/@NullFlavor” **SHALL** be “NA” “Not applicable” 2.16.840.1.113883.5.1008 NullFlavor STATIC (CONF:1198-8457). (: )
1198-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:1198-16790). (: )
521. 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
522. 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
523. 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
524. 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

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

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

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

534. 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.
535. 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.
536. 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.
537. 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.
538. 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.
539. 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.
540. 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
541. 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
542. 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.
543. 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()))
544. 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).

545. 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.
546. ClinicalDocument.author.assignedAuthor.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
547. 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.
548. 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).

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

550. 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
551. 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
552. 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
553. 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()))
554. 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.
555. 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).

556. 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
557. 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
558. 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
559. 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
560. 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).

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

562. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/MaintainedEntity
563. ClinicalDocument.author.assignedAuthor.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
564. ClinicalDocument.dataEnterer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/DataEnterer
Requirements

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

565. 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.
566. 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
567. 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
568. 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
569. 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
570. 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
571. ClinicalDocument.dataEnterer.time
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
572. 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).

573. 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
574. 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
575. 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).

576. 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.
577. 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.
578. 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.
579. 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
580. 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.
581. 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.
582. 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).

583. 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()))
584. 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).

585. 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.
586. ClinicalDocument.dataEnterer.assignedEntity.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
587. 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.
588. 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).

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

590. 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
591. 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
592. 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
593. 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()))
594. 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.
595. ClinicalDocument.dataEnterer.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
596. 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
597. 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

598. 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.
599. 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
600. 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
601. 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
602. 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
603. 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
604. ClinicalDocument.informant:informant1.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

605. 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
606. 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
607. 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). (: )
608. 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.
609. 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).

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

613. 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
614. 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
615. 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
616. 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()))
617. 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.
618. ClinicalDocument.informant:informant1.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
619. ClinicalDocument.informant:informant1.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
620. 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

621. 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.
622. 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
623. 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
624. 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
625. 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
626. 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
627. ClinicalDocument.informant:informant2.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
628. ClinicalDocument.informant:informant2.relatedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
Requirements

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

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

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

630. 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.
631. 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
632. 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
633. 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
634. 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
635. 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).

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

639. 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
640. 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
641. 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
642. 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).

643. 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.
644. 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.
645. 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.
646. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.root
Definition

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

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

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

650. 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.
651. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
652. 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.
653. 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).

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

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

656. 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.
657. 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
658. 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
659. 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
660. 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
661. 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).

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

665. 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.
666. ClinicalDocument.informationRecipient.intendedRecipient.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
667. ClinicalDocument.informationRecipient.intendedRecipient.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
668. 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).

669. 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
670. 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
671. 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
672. 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()))
673. 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.
674. 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).

675. 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
676. 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
677. 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
678. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
679. 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).

680. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
681. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
682. 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
683. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/OrganizationPartOf
684. ClinicalDocument.legalAuthenticator
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/LegalAuthenticator
Requirements

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

685. 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.
686. 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
687. 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
688. 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
689. 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
690. 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
691. 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()))
692. 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).

693. 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.
694. 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
695. 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.
696. 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.
697. 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.
698. 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.
699. 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.
700. 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.
701. 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
702. 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
703. 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.
704. 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.
705. 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).

706. 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
707. 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
708. 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).

709. 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.
710. 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.
711. 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.
712. 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
713. 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.
714. 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.
715. 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).

716. 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()))
717. 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).

718. 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.
719. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
720. 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.
721. 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).

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

723. 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
724. 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
725. 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
726. 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()))
727. 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.
728. ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
729. 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,
730. 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

731. 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.
732. 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
733. 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
734. 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
735. 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
736. 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()))
737. ClinicalDocument.authenticator:authenticator1.signatureCode
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

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

738. 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.
739. 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
740. 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.
741. 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.
742. 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.
743. 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.
744. 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.
745. 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.
746. 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
747. 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
748. 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.
749. 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.
750. ClinicalDocument.authenticator:authenticator1.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

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

751. 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
752. 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
753. 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).

754. 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.
755. 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.
756. 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.
757. 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
758. 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.
759. 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.
760. 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).

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

763. 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.
764. 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.
765. 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.
766. 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.
767. 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.
768. 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.
769. 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
770. 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
771. 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.
772. 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()))
773. 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).

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

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

779. 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
780. 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
781. 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
782. 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()))
783. 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.
784. ClinicalDocument.authenticator:authenticator1.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
785. ClinicalDocument.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant1
SlicingThis element introduces a set of slices on ClinicalDocument.participant. The slices are unordered and Open, and defines no discriminators to differentiate the slices
786. ClinicalDocument.participant:participant1
SliceNameparticipant1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant1
Requirements

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

InvariantsDefined on this element
1198-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:1198-10006). (: )
1198-10007: When participant/@typeCode is *IND*, associatedEntity/@classCode **SHOULD** be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *STATIC 2011-09-30* (CONF:1198-10007). (: )
787. 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.
788. ClinicalDocument.participant:participant1.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
789. 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
790. 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
791. 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
792. 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
793. ClinicalDocument.participant:participant1.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
794. 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).

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

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

797. 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.
798. 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
799. 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
800. 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
801. 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
802. 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).

803. 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
804. 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
805. 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
806. 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).

807. 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
808. 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
809. ClinicalDocument.documentationOf
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/DocumentationOf
Requirements

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

810. 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.
811. 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
812. 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
813. 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
814. 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
815. ClinicalDocument.documentationOf.serviceEvent
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ServiceEvent
Requirements

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

816. 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 STATIC) (CONF:1198-8453).

Default ValueACT
Pattern ValuePCPR
817. 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
818. 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
819. ClinicalDocument.documentationOf.serviceEvent.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
820. ClinicalDocument.documentationOf.serviceEvent.code
Definition

Drawn from concept domain ActCode

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
821. 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-8481).

822. 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.
823. 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.
824. 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.
825. 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.
826. 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-8454).

827. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
Definition

This is the high limit of the interval.

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

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

828. 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
829. 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
830. ClinicalDocument.documentationOf.serviceEvent.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer1
Requirements

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

831. 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.
832. 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="PRF" Participation physical performer (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8458).

Fixed ValueDOC
Pattern ValuePRF
833. 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
834. 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
835. 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
836. 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).

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

839. 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.
840. 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.
841. 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.
842. 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.
843. 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.
844. 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.
845. 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
846. 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
847. 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.
848. ClinicalDocument.documentationOf.serviceEvent.performer.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
849. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

The performer, if present, MAY contain zero or one [0..1] assignedEntity (CONF:1198-8459).

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

SlicingThis element introduces a set of slices on ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id. The slices are unordered and Open, and defines no discriminators to differentiate the slices
853. 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.
854. 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.
855. 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.
856. 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
857. 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.
858. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id:id1
SliceNameid1
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

InvariantsDefined on this element
1198-32466: If this assignedEntity is an assignedPerson, the assignedEntity/id **SHOULD** contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-32466). (: )
859. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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.
860. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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.
861. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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.
862. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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.

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
863. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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.
864. 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.
865. 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).

866. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
867. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
868. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
Requirements

The assignedEntity, if present, MAY contain zero or one [0..1] assignedPerson (CONF:1198-32467).

869. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
870. ClinicalDocument.relatedDocument
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedDocument
871. 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
872. 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

873. 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.
874. 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
875. 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
876. 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
877. 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
878. ClinicalDocument.authorization:authorization1.consent
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Consent
Requirements

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

879. 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
880. 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
881. 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
882. 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).

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

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

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

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

887. 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.
888. 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
889. 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
890. 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
891. 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
892. 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).

893. 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
894. 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
895. 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
896. 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).

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

899. 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.
900. 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
901. 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()))
902. 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
903. 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
904. 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
905. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
906. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/EncounterParticipant
907. 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()))
908. 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
909. 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
910. 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
911. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/HealthCareFacility
912. ClinicalDocument.component
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Component2
Requirements

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

913. 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.
914. 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
915. ClinicalDocument.component.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
916. 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
917. 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
918. 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
919. ClinicalDocument.component.nonXMLBody
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/NonXMLBody
920. ClinicalDocument.component.structuredBody
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/StructuredBody
Requirements

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

921. 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
922. 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
923. ClinicalDocument.component.structuredBody.confidentialityCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
924. ClinicalDocument.component.structuredBody.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
925. ClinicalDocument.component.structuredBody.component
Control1..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on ClinicalDocument.component.structuredBody.component. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ section
926. 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
927. 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
928. ClinicalDocument.component.structuredBody.component.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
929. ClinicalDocument.component.structuredBody.component.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
930. ClinicalDocument.component.structuredBody.component.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section
931. ClinicalDocument.component.structuredBody.component:allergies
SliceNameallergies
Control1..1
TypeElement
Requirements

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

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

Base definition for all types defined in FHIR type system.

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

This component 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-30662).

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

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

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

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
944. ClinicalDocument.component.structuredBody.component:problems.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
945. ClinicalDocument.component.structuredBody.component:problems.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
946. ClinicalDocument.component.structuredBody.component:problems.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
947. ClinicalDocument.component.structuredBody.component:problems.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
948. ClinicalDocument.component.structuredBody.component:problems.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-30666).

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

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

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

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

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

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

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

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

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Advance Directives Section (entries optional) (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.21:2015-08-01) (CONF:1198-30672).

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
968. 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
969. 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
970. 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
971. ClinicalDocument.component.structuredBody.component:encounters.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
972. 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(EncountersSectionentriesoptional)
Requirements

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

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
974. ClinicalDocument.component.structuredBody.component:famHistory.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
975. ClinicalDocument.component.structuredBody.component:famHistory.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
976. ClinicalDocument.component.structuredBody.component:famHistory.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
977. ClinicalDocument.component.structuredBody.component:famHistory.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
978. ClinicalDocument.component.structuredBody.component:famHistory.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-30676).

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

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

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

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

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

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

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

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

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

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:medEquipment.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
993. ClinicalDocument.component.structuredBody.component:medEquipment.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
994. ClinicalDocument.component.structuredBody.component:medEquipment.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
995. ClinicalDocument.component.structuredBody.component:medEquipment.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
996. ClinicalDocument.component.structuredBody.component:medEquipment.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-30682).

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

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

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: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
999. 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
1000. 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
1001. ClinicalDocument.component.structuredBody.component:payers.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1002. 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-30684).

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

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

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: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
1005. 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
1006. 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
1007. ClinicalDocument.component.structuredBody.component:planOfTreatment.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1008. 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-30686).

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

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

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:socialHist.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
1011. ClinicalDocument.component.structuredBody.component:socialHist.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
1012. ClinicalDocument.component.structuredBody.component:socialHist.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
1013. ClinicalDocument.component.structuredBody.component:socialHist.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1014. ClinicalDocument.component.structuredBody.component:socialHist.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-30688).

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

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

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: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
1017. 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
1018. 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
1019. ClinicalDocument.component.structuredBody.component:vitalSigns.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1020. 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-30690).

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

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

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: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
1023. 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
1024. 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
1025. ClinicalDocument.component.structuredBody.component:mentalStatus.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1026. 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-32144).

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

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

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: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
1029. 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
1030. 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
1031. ClinicalDocument.component.structuredBody.component:nutrition.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
1032. 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-32625).

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