Consolidated CDA (C-CDA)
4.0.0-ballot - STU4 Ballot United States of America flag

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions

Logical Model: USRealmHeaderforPatientGeneratedDocument - Detailed Descriptions

Active as of 2024-12-19

Definitions for the USRealmHeaderforPatientGeneratedDocument logical model.

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

0. ClinicalDocument
Logical ContainerClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. ClinicalDocument.templateId
Control2..?
4. ClinicalDocument.templateId:us-patient-gen-doc
Slice Nameus-patient-gen-doc
Control1..1
6. ClinicalDocument.templateId:us-patient-gen-doc.root
Control1..?
Pattern Value2.16.840.1.113883.10.20.29.1
8. ClinicalDocument.templateId:us-patient-gen-doc.extension
Control1..?
Pattern Value2024-05-01
10. ClinicalDocument.recordTarget
ShortThe recordTarget records the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element. If the document receiver is interested in setting up a translator for the encounter with the patient, the receiver of the document will have to infer the need for a translator, based upon the language skills identified for the patient, the patient's language of preference and the predominant language used by the organization receiving the CDA. HL7 Vocabulary simply describes guardian as a relationship to a ward. This need not be a formal legal relationship. When a guardian relationship exists for the patient, it can be represented, regardless of who is present at the time the document is generated. This need not be a formal legal relationship. A child's parent can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of "mother" for the child's mom or "father" for the child's dad. An elderly person's child can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of "daughter" or "son", or if a legal relationship existed, the relationship of "legal guardian" could be encoded.
Comments

SHALL contain exactly one [1..1] recordTarget (CONF:1198-28460).

Control0..1
12. ClinicalDocument.recordTarget.patientRole
Comments

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

14. ClinicalDocument.recordTarget.patientRole.id
Comments

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

16. ClinicalDocument.recordTarget.patientRole.patient
Comments

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

Invariantsshould-languageCommunication: SHOULD contain languageCommunication (languageCommunication.exists())
18. ClinicalDocument.recordTarget.patientRole.patient.guardian
Comments

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

Invariantsshould-id: SHOULD contain id (id.exists())
should-code: SHOULD contain code (code.exists())
20. ClinicalDocument.recordTarget.patientRole.patient.guardian.id
Comments

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

22. ClinicalDocument.recordTarget.patientRole.patient.guardian.code
Comments

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

24. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication
Comments

This patient SHOULD contain zero or more [0..*] languageCommunication which SHALL be selected from ValueSet AllLanguages https://www.hl7.org/fhir/valueset-all-languages.html (OID 2.16.840.1.113883.4.642.3.21) DYNAMIC (CONF:XXX).

26. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode
BindingThe codes SHALL be taken from AllLanguages
(required to http://hl7.org/fhir/ValueSet/all-languages)
28. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd
ShortIndicates a preference for information about care delivery and treatments be communicated (or translated if needed) into this language. If more than one languageCommunication is present, only one languageCommunication element SHALL have a preferenceInd with a value of 1.
Comments

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

30. ClinicalDocument.recordTarget.patientRole.providerOrganization
ShortIf present, this organization represents the provider organization where the person is claiming to be a patient.
Comments

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

LabelIf present, this organization represents the provider organization where the person is claiming to be a patient.
32. ClinicalDocument.author
ShortThe author element represents the creator of the clinical document. The author may be a device, or a person. The person is the patient or the patient's advocate.
Comments

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

34. ClinicalDocument.author.assignedAuthor
Comments

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

Invariantsshould-code: SHOULD contain code (code.exists())
36. ClinicalDocument.author.assignedAuthor.id
Comments

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

38. ClinicalDocument.author.assignedAuthor.code
ShortWhen the author is a person who is not acting in the role of a clinician, this code encodes the personal or legal relationship between author and the patient.
Comments

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

40. ClinicalDocument.author.assignedAuthor.code.code
BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type .
(preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
42. ClinicalDocument.dataEnterer
ShortThe dataEnterer element represents the person who transferred the content, written or dictated by someone else, into the clinical document. The guiding rule of thumb is that an author provides the content found within the header or body of the document, subject to their own interpretation, and the dataEnterer adds that information to the electronic system. In other words, a dataEnterer transfers information from one source to another (e.g., transcription from paper form to electronic system). If the dataEnterer is missing, this role is assumed to be played by the author.
Comments

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

44. ClinicalDocument.dataEnterer.assignedEntity
Comments

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

46. ClinicalDocument.dataEnterer.assignedEntity.code
Comments

This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28680).

BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type .
(preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
48. ClinicalDocument.informant:non-provider
Slice Namenon-provider
50. ClinicalDocument.informant:non-provider.relatedEntity
Comments

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

52. ClinicalDocument.informant:non-provider.relatedEntity.code
Comments

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

Invariantsshould-us-code-attr: SHOULD contain @code (code.exists())
54. ClinicalDocument.informant:non-provider.relatedEntity.code.code
Comments

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

BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type .
(preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
56. ClinicalDocument.custodian
ShortThe custodian element represents the organization or person that is in charge of maintaining the document. The custodian is the steward that is entrusted with the care of the document. Every CDA document has exactly one custodian. The custodian participation satisfies the CDA definition of Stewardship. Because CDA is an exchange standard and may not represent the original form of the authenticated document (e.g., CDA could include scanned copy of original), the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party. Also, the custodian may be the patient or an organization acting on behalf of the patient, such as a PHR organization.
Comments

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

58. ClinicalDocument.custodian.assignedCustodian
Comments

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

60. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
ShortThe representedCustodianOrganization may be the person when the document is not maintained by an organization.
Comments

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

62. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
ShortThe combined @root and @extension attributes record the custodian organization's identity in a secure, trusted, and unique way.
Comments

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

64. ClinicalDocument.informationRecipient
ShortThe informationRecipient element records the intended recipient of the information at the time the document is created. For example, in cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to be the scoping organization for that chart.
Comments

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

66. ClinicalDocument.informationRecipient.intendedRecipient
Comments

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

Invariantsshould-id: SHOULD contain id (id.exists())
68. ClinicalDocument.informationRecipient.intendedRecipient.id
ShortThe combined @root and @extension attributes to record the information recipient's identity in a secure, trusted, and unique way.
Comments

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

Invariantsshould-root: SHOULD contain @root (root.exists())
70. ClinicalDocument.informationRecipient.intendedRecipient.id.root
ShortFor a provider, the id/@root ="2.16.840.1.113883.4.6" indicates the National Provider Identifier where id/@extension is the NPI number for the provider. The ids MAY reference the id of a person or organization entity specified elsewhere in the document.
Comments

The id, if present, SHOULD contain zero or one [0..1] @root (CONF:1198-28693).

72. ClinicalDocument.legalAuthenticator
ShortIn a patient authored document, the legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. (Note that per the following section, there may also be one or more document authenticators.) Based on local practice, patient authored documents may be provided without legal authentication. This implies that a patient authored document that does not contain this element has not been legally authenticated. The act of legal authentication requires a certain privilege be granted to the legal authenticator depending upon local policy. All patient documents have the potential for legal authentication, given the appropriate legal authority. Local policies MAY choose to delegate the function of legal authentication to a device or system that generates the document. In these cases, the legal authenticator is the person accepting responsibility for the document, not the generating device or system. Note that the legal authenticator, if present, must be a person.
Comments

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

74. ClinicalDocument.legalAuthenticator.assignedEntity
Comments

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

76. ClinicalDocument.legalAuthenticator.assignedEntity.id
ShortThe combined @root and @extension attributes to record the information recipient's identity in a secure, trusted, and unique way.
Comments

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

78. ClinicalDocument.legalAuthenticator.assignedEntity.code
Comments

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

80. ClinicalDocument.legalAuthenticator.assignedEntity.code.code
Comments

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

BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type .
(preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
82. ClinicalDocument.authenticator
Comments

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

84. ClinicalDocument.authenticator.assignedEntity
Comments

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

Invariantsshould-code: SHOULD contain code (code.exists())
86. ClinicalDocument.authenticator.assignedEntity.id
ShortThe combined @root and @extension attributes to record the authenticator's identity in a secure, trusted, and unique way.
Comments

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

88. ClinicalDocument.authenticator.assignedEntity.code
Comments

This assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28702).

BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type .
(preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
90. ClinicalDocument.participant
ShortThe participant element identifies other supporting participants, including parents, relatives, caregivers, insurance policyholders, guarantors, and other participants related in some way to the patient. A supporting person or organization is an individual or an organization with a relationship to the patient. A supporting person who is playing multiple roles would be recorded in multiple participants (e.g., emergency contact and next-of-kin)
Comments

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

92. ClinicalDocument.participant.typeCode
ShortUnless otherwise specified by the document specific header constraints, when participant/@typeCode is IND, associatedEntity/@classCode SHALL be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes STATIC 2011-09-30
Comments

The participant, if present, SHALL contain exactly one [1..1] @typeCode (CONF:1198-28704).

94. ClinicalDocument.participant.associatedEntity
Comments

The participant, if present, SHALL contain exactly one [1..1] associatedEntity (CONF:1198-28705).

Invariantsshould-code: SHOULD contain code (code.exists())
96. ClinicalDocument.participant.associatedEntity.code
Comments

This associatedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28706).

BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type .
(preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
98. ClinicalDocument.inFulfillmentOf
Comments

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

100. ClinicalDocument.inFulfillmentOf.order
Comments

The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:1198-28708).

102. ClinicalDocument.inFulfillmentOf.order.id
ShortA scheduled appointment or service event in a practice management system may be represented using this id element.
Comments

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

104. ClinicalDocument.documentationOf
Comments

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

106. ClinicalDocument.documentationOf.serviceEvent
Comments

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

Invariantsshould-code: SHOULD contain code (code.exists())
should-performer: SHOULD contain performer (performer.exists())
108. ClinicalDocument.documentationOf.serviceEvent.code
ShortThe code should be selected from a value set established by the document-level template for a specific type of Patient Generated Document.
Comments

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

110. ClinicalDocument.documentationOf.serviceEvent.performer
Comments

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

112. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode
ShortWhen indicating the performer was the primary care physician, implementers should indicate "PCP" as the functionCode
114. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.code
BindingThe codes SHALL be taken from ParticipationFunction .
(required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.10267)
116. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Comments

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

118. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
ShortThe combined @root and @extension attributes record the performer's identity in a secure, trusted, and unique way.
Comments

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

120. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code
ShortIf the assignedEntity is an individual, the code SHOULD be selected from value set PersonalandLegalRelationshipRoleType value set
Comments

This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28718).

BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type .
(preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)

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

0. ClinicalDocument
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.


Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control10..1*
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariants4537-6380: If setId is present versionNumber **SHALL** be present (CONF:4537-6380). (setId.exists() implies versionNumber.exists())
4537-6387: If versionNumber is present setId **SHALL** be present (CONF:4537-6387). (versionNumber.exists() implies setId.exists())
should-legalAuthenticator: SHOULD contain legalAuthenticator (legalAuthenticator.exists())
should-relatedParticipant: Documents SHOULD contain a RelatedPerson participant (participant.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/RelatedPersonRelationshipAndNameParticipant').exists())
2. ClinicalDocument.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
4. ClinicalDocument.classCode
Control0..1
BindingFor example codes, see CDAActClass
(example to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDOCCLIN
6. ClinicalDocument.moodCode
Control0..1
BindingThe codes SHALL be taken from CDAActMood
(required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
8. 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

Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
10. ClinicalDocument.realmCode.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
12. ClinicalDocument.realmCode.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
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode
Pattern ValueUS
14. ClinicalDocument.realmCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System
16. ClinicalDocument.realmCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Name
18. ClinicalDocument.realmCode.codeSystemVersion
Definition

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

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Version
20. ClinicalDocument.realmCode.displayName
Definition

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

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplay Name
22. ClinicalDocument.realmCode.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(oid: ISO Object Identifier)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn 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 namevalueSet.
24. ClinicalDocument.realmCode.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(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn 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 namevalueSetVersion.
26. ClinicalDocument.realmCode.originalText
Definition

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

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
28. ClinicalDocument.realmCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
LabelQualifier
30. ClinicalDocument.realmCode.translation
Definition

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

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
32. ClinicalDocument.typeId
Definition

ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = "2.16.840.1.113883.1.3" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = "POCD_HD000040" (which is the unique identifier for the CDA, Release Two Hierarchical Description).

Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
34. 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 CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
36. 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(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
38. 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(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
40. ClinicalDocument.typeId.root
Definition

Identifies the type as an HL7 Registered model

Comments

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

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
42. ClinicalDocument.typeId.extension
Definition

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

Comments

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

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
Fixed ValuePOCD_HD000040
44. 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

Control2..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
SlicingThis element introduces a set of slices on ClinicalDocument.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
  • 46. ClinicalDocument.templateId:us-realm
    Slice Nameus-realm
    Definition

    When valued in an instance, this attribute 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/cda/stds/core/StructureDefinition/II
    48. ClinicalDocument.templateId:us-realm.nullFlavor
    Definition

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

    Control0..1
    BindingThe codes SHALL be taken from CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    50. ClinicalDocument.templateId:us-realm.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(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelAssigning Authority Name
    52. ClinicalDocument.templateId:us-realm.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(bl: Boolean)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelDisplayable
    54. ClinicalDocument.templateId:us-realm.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(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelRoot
    Pattern Value2.16.840.1.113883.10.20.22.1.1
    56. ClinicalDocument.templateId:us-realm.extension
    Definition

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

    Control1..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExtension
    Pattern Value2024-05-01
    58. ClinicalDocument.templateId:us-patient-gen-doc
    Slice Nameus-patient-gen-doc
    Definition

    When valued in an instance, this attribute 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/cda/stds/core/StructureDefinition/II
    60. ClinicalDocument.templateId:us-patient-gen-doc.nullFlavor
    Definition

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

    Control0..1
    BindingThe codes SHALL be taken from CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    62. ClinicalDocument.templateId:us-patient-gen-doc.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(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelAssigning Authority Name
    64. ClinicalDocument.templateId:us-patient-gen-doc.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(bl: Boolean)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelDisplayable
    66. ClinicalDocument.templateId:us-patient-gen-doc.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(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelRoot
    Pattern Value2.16.840.1.113883.10.20.29.1
    68. ClinicalDocument.templateId:us-patient-gen-doc.extension
    Definition

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

    Control1..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExtension
    Pattern Value2024-05-01
    70. ClinicalDocument.id
    Short**SHALL** be a globally unique identifier for the document (CONF:4537-9991).
    Comments

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

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    72. ClinicalDocument.sdtcCategory
    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
    XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namecategory.
    74. ClinicalDocument.code
    Short**SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992).
    Comments

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

    Control1..1
    BindingFor example codes, see FHIRDocumentTypeCodes
    (example to http://hl7.org/fhir/ValueSet/doc-typecodes)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
    76. 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..0
    BindingThe codes SHALL be taken from CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    78. 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
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelCode
    80. ClinicalDocument.code.codeSystem
    Definition

    Specifies the code system that defines the code.

    Control1..1
    Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelCode System
    Pattern Value2.16.840.1.113883.6.1
    82. ClinicalDocument.code.codeSystemName
    Definition

    The common name of the coding system.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelCode System Name
    84. ClinicalDocument.code.codeSystemVersion
    Definition

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

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelCode System Version
    86. 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(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelDisplay Name
    88. 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(oid: ISO Object Identifier)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn 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 namevalueSet.
    90. 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(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn 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 namevalueSetVersion.
    92. ClinicalDocument.code.originalText
    Definition

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

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
    LabelOriginal Text
    94. ClinicalDocument.code.qualifier
    Definition

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

    Control0..0
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
    LabelQualifier
    96. ClinicalDocument.code.translation
    Definition

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

    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
    XML FormatThe type of this property is determined using the xsi:typeattribute.
    LabelTranslation
    98. ClinicalDocument.title
    ShortThe title can either be a locally defined name or the displayName corresponding to clinicalDocument/code
    Comments

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

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
    100. ClinicalDocument.sdtcStatusCode
    Definition

    The statusCode extension attribute allows the implementer to identify a ClinicalDocument that is in other than the completed state. It was created to support the Structured Form Definition IG to identify that the document itself is an unfinished product currently being completed for a patient.

    Control0..1
    BindingThe codes SHALL be taken from ActStatus
    (required to http://terminology.hl7.org/ValueSet/v3-ActStatus)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
    XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namestatusCode.
    102. 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.

    ShortBase for all types and resources
    Comments

    SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5256).

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
    Is Modifierfalse
    Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
    ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
    104. ClinicalDocument.confidentialityCode
    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
    106. ClinicalDocument.confidentialityCode.nullFlavor
    Definition

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

    Control0..0
    BindingThe codes SHALL be taken from CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    108. ClinicalDocument.confidentialityCode.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 HL7 BasicConfidentialityKind .
    (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.16926)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelCode
    110. ClinicalDocument.confidentialityCode.codeSystem
    Definition

    Specifies the code system that defines the code.

    Control0..1
    Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelCode System
    112. ClinicalDocument.confidentialityCode.codeSystemName
    Definition

    The common name of the coding system.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelCode System Name
    114. ClinicalDocument.confidentialityCode.codeSystemVersion
    Definition

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

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelCode System Version
    116. ClinicalDocument.confidentialityCode.displayName
    Definition

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

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelDisplay Name
    118. ClinicalDocument.confidentialityCode.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(oid: ISO Object Identifier)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn 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 namevalueSet.
    120. ClinicalDocument.confidentialityCode.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(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn 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 namevalueSetVersion.
    122. ClinicalDocument.confidentialityCode.originalText
    Definition

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

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
    LabelOriginal Text
    124. ClinicalDocument.confidentialityCode.qualifier
    Definition

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

    Control0..0
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
    LabelQualifier
    126. ClinicalDocument.confidentialityCode.translation
    Definition

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

    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
    XML FormatThe type of this property is determined using the xsi:typeattribute.
    LabelTranslation
    128. ClinicalDocument.languageCode
    Comments

    SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet AllLanguages https://www.hl7.org/fhir/valueset-all-languages.html (OID 2.16.840.1.113883.4.642.3.21) DYNAMIC.

    Control1..1
    BindingThe codes SHALL be taken from AllLanguages
    (required to http://hl7.org/fhir/ValueSet/all-languages)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
    130. ClinicalDocument.setId
    Comments

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

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    132. ClinicalDocument.versionNumber
    Comments

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

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
    134. ClinicalDocument.copyTime
    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
    136. ClinicalDocument.recordTarget
    ShortThe recordTarget records the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element. If the document receiver is interested in setting up a translator for the encounter with the patient, the receiver of the document will have to infer the need for a translator, based upon the language skills identified for the patient, the patient's language of preference and the predominant language used by the organization receiving the CDA. HL7 Vocabulary simply describes guardian as a relationship to a ward. This need not be a formal legal relationship. When a guardian relationship exists for the patient, it can be represented, regardless of who is present at the time the document is generated. This need not be a formal legal relationship. A child's parent can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of "mother" for the child's mom or "father" for the child's dad. An elderly person's child can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of "daughter" or "son", or if a legal relationship existed, the relationship of "legal guardian" could be encoded.
    Comments

    SHALL contain exactly one [1..1] recordTarget (CONF:1198-28460).

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
    138. 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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    140. 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/cda/stds/core/StructureDefinition/CS
    142. 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/cda/stds/core/StructureDefinition/II
    InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
    144. ClinicalDocument.recordTarget.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    146. ClinicalDocument.recordTarget.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(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelAssigning Authority Name
    148. ClinicalDocument.recordTarget.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(bl: Boolean)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelDisplayable
    150. ClinicalDocument.recordTarget.typeId.root
    Definition

    Identifies the type as an HL7 Registered model

    Control1..1
    Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelRoot
    Fixed Value2.16.840.1.113883.1.3
    152. ClinicalDocument.recordTarget.typeId.extension
    Definition

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

    Control1..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExtension
    154. 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/cda/stds/core/StructureDefinition/II
    156. ClinicalDocument.recordTarget.typeCode
    Control0..1
    BindingThe codes SHALL be taken from CDAParticipationType
    (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueRCT
    158. ClinicalDocument.recordTarget.contextControlCode
    Control0..1
    BindingThe codes SHALL be taken from CDAContextControl
    (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueOP
    160. ClinicalDocument.recordTarget.patientRole
    Comments

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

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/PatientRole
    162. ClinicalDocument.recordTarget.patientRole.nullFlavor
    Definition

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

    Control0..1
    BindingThe codes SHALL be taken from CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    164. ClinicalDocument.recordTarget.patientRole.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/cda/stds/core/StructureDefinition/CS
    166. ClinicalDocument.recordTarget.patientRole.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/cda/stds/core/StructureDefinition/II
    InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
    168. ClinicalDocument.recordTarget.patientRole.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    170. ClinicalDocument.recordTarget.patientRole.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(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelAssigning Authority Name
    172. ClinicalDocument.recordTarget.patientRole.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(bl: Boolean)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelDisplayable
    174. ClinicalDocument.recordTarget.patientRole.typeId.root
    Definition

    Identifies the type as an HL7 Registered model

    Control1..1
    Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelRoot
    Fixed Value2.16.840.1.113883.1.3
    176. ClinicalDocument.recordTarget.patientRole.typeId.extension
    Definition

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

    Control1..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExtension
    178. 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/cda/stds/core/StructureDefinition/II
    180. ClinicalDocument.recordTarget.patientRole.classCode
    Control0..1
    BindingThe codes SHALL be taken from RoleClassRelationshipFormal
    (required to http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValuePAT
    182. ClinicalDocument.recordTarget.patientRole.id
    Comments

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

    Control1..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    184. ClinicalDocument.recordTarget.patientRole.sdtcIdentifiedBy
    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
    XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
    186. 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.

    Short𝗨𝗦𝗖𝗗𝗜: Address
    Comments

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

    Control1..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
    Is Modifierfalse
    Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
    shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
    should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
    should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
    81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
    81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
    81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
    shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
    188. ClinicalDocument.recordTarget.patientRole.telecom
    Short𝗨𝗦𝗖𝗗𝗜: Phone Number / Email
    Control1..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
    Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
    190. 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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    192. ClinicalDocument.recordTarget.patientRole.telecom.value
    Control0..1
    Typeurl(url: Universal Resource Locator)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    194. 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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
    Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
    XML FormatThe type of this property is determined using the xsi:typeattribute.
    LabelUseable Period
    196. 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.

    Comments

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

    Control0..1
    BindingThe codes SHALL be taken from Telecom Use (US Realm Header) .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelUse Code
    198. ClinicalDocument.recordTarget.patientRole.patient
    Comments

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

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Patient
    Invariants4537-32993: If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present with either a @value or @nullFlavor=UNK (CONF:4537-32993). (sdtcDeceasedInd.exists(value='true') implies sdtcDeceasedTime.exists())
    4537-21000: If sdtc:deceasedTime/@value is present, then sdtc:deceasedInd SHALL be present with value=true (sdtcDeceasedTime.value.exists() implies sdtcDeceasedInd.exists(value='true'))
    should-maritalStatusCode: SHOULD contain maritalStatusCode (maritalStatusCode.exists())
    should-us-languageCommunication: SHOULD contain languageCommunication (languageCommunication.exists())
    should-languageCommunication: SHOULD contain languageCommunication (languageCommunication.exists())
    200. ClinicalDocument.recordTarget.patientRole.patient.nullFlavor
    Definition

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

    Control0..1
    BindingThe codes SHALL be taken from CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    202. ClinicalDocument.recordTarget.patientRole.patient.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/cda/stds/core/StructureDefinition/CS
    204. ClinicalDocument.recordTarget.patientRole.patient.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/cda/stds/core/StructureDefinition/II
    InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
    206. ClinicalDocument.recordTarget.patientRole.patient.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    208. ClinicalDocument.recordTarget.patientRole.patient.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(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelAssigning Authority Name
    210. ClinicalDocument.recordTarget.patientRole.patient.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(bl: Boolean)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelDisplayable
    212. ClinicalDocument.recordTarget.patientRole.patient.typeId.root
    Definition

    Identifies the type as an HL7 Registered model

    Control1..1
    Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelRoot
    Fixed Value2.16.840.1.113883.1.3
    214. ClinicalDocument.recordTarget.patientRole.patient.typeId.extension
    Definition

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

    Control1..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExtension
    216. 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/cda/stds/core/StructureDefinition/II
    218. ClinicalDocument.recordTarget.patientRole.patient.classCode
    Control0..1
    BindingThe codes SHALL be taken from EntityClassLivingSubject
    (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValuePSN
    220. ClinicalDocument.recordTarget.patientRole.patient.determinerCode
    Control0..1
    BindingThe codes SHALL be taken from EntityDeterminer
    (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueINSTANCE
    222. ClinicalDocument.recordTarget.patientRole.patient.id
    Definition

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

    ShortLogical id of this artifact
    Comments

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

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/IIid
    Is Modifierfalse
    224. 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.

    ShortBase for all types and resourcesA name associated with the patient
    Comments

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


    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.

    Control10..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Patient Name (PTN.US.FIELDED))
    Is Modifierfalse
    Requirements

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

    Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
    shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). (nullFlavor.exists() or item.family.count() = 1)
    shall-given: SHALL contain at least one [1..*] given (CONF:81-7157). (nullFlavor.exists() or item.given.exists())
    shall-max-suffix: There may be at most one suffix ((item.suffix.empty() or item.suffix.count() = 1))
    81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). (item.xmlText.empty())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    226. ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc
    Definition

    The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
    XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
    228. ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode
    Comments

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

    Control1..1
    BindingThe codes SHALL be taken from Administrative Gender (HL7 V3) .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.1)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
    230. ClinicalDocument.recordTarget.patientRole.patient.birthTime
    Short𝗨𝗦𝗖𝗗𝗜: Date of Birth - **MAY** be precise to the minute (CONF:4537-32418) (For cases where information about newborn's time of birth needs to be captured)
    Comments

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

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
    Invariantsts-shall-year: **SHALL** be precise to at least the year (nullFlavor.exists() or value.toString().length() >= 4)
    ts-should-day: **SHOULD** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
    232. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd
    Shortsdtc:deceasedInd
    Comments

    This patient MAY contain zero or one [0..1] sdtc:deceasedInd (CONF:4537-32990).

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
    XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedInd.
    234. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime
    Short𝗨𝗦𝗖𝗗𝗜: Date of Death
    Comments

    This patient MAY contain zero or one [0..1] sdtc:deceasedTime (CONF:4537-32988).

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
    XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedTime.
    Invariantsshould-value-att: SHOULD contain @value (value.exists())
    ts-shall-year: **SHALL** be precise to at least the year (nullFlavor.exists() or value.toString().length() >= 4)
    ts-should-day: **SHOULD** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
    236. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd
    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
    XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthInd.
    238. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber
    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT-POS
    XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthOrderNumber.
    240. ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode
    Comments

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

    Control0..1
    BindingThe codes SHALL be taken from Marital Status .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12212)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
    242. ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode
    Comments

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

    Control0..1
    BindingThe codes SHALL be taken from Religious Affiliation .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19185)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
    244. ClinicalDocument.recordTarget.patientRole.patient.raceCode
    Short𝗨𝗦𝗖𝗗𝗜: Race
    Comments

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

    Control1..1
    BindingThe codes SHALL be taken from Race Category Excluding Nulls .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.2074.1.1.3)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
    246. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode
    Short𝗨𝗦𝗖𝗗𝗜: Race - The sdtc:raceCode is only used to record additional values when the patient has indicated multiple races or additional race detail beyond the five categories required for Meaningful Use Stage 2. The prefix sdtc: SHALL be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the additional raceCode elements.
    Comments

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

    Control0..*
    BindingThe codes SHALL be taken from Race Value Set .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
    XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameraceCode.
    248. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode
    Short𝗨𝗦𝗖𝗗𝗜: Ethnicity
    Comments

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

    Control1..1
    BindingThe codes SHALL be taken from Ethnicity .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.837)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
    250. ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode
    Short𝗨𝗦𝗖𝗗𝗜: Ethnicity
    Comments

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

    Control0..*
    BindingThe codes SHALL be taken from Detailed Ethnicity .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.877)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
    XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameethnicGroupCode.
    252. ClinicalDocument.recordTarget.patientRole.patient.guardian
    Comments

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

    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Guardian
    Invariantsshould-us-code: SHOULD contain code (code.exists())
    should-us-addr: SHOULD contain addr (addr.exists())
    should-us-telecom: SHOULD contain telecom (telecom.exists())
    should-id: SHOULD contain id (id.exists())
    should-code: SHOULD contain code (code.exists())
    254. ClinicalDocument.recordTarget.patientRole.patient.guardian.nullFlavor
    Definition

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

    Control0..1
    BindingThe codes SHALL be taken from CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    256. ClinicalDocument.recordTarget.patientRole.patient.guardian.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/cda/stds/core/StructureDefinition/CS
    258. ClinicalDocument.recordTarget.patientRole.patient.guardian.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/cda/stds/core/StructureDefinition/II
    InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
    260. ClinicalDocument.recordTarget.patientRole.patient.guardian.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    262. ClinicalDocument.recordTarget.patientRole.patient.guardian.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(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelAssigning Authority Name
    264. ClinicalDocument.recordTarget.patientRole.patient.guardian.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(bl: Boolean)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelDisplayable
    266. ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.root
    Definition

    Identifies the type as an HL7 Registered model

    Control1..1
    Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelRoot
    Fixed Value2.16.840.1.113883.1.3
    268. ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.extension
    Definition

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

    Control1..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExtension
    270. 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/cda/stds/core/StructureDefinition/II
    272. ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode
    Control0..1
    BindingThe codes SHALL be taken from RoleClassAgent
    (required to http://terminology.hl7.org/ValueSet/v3-RoleClassAgent)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueGUARD
    274. ClinicalDocument.recordTarget.patientRole.patient.guardian.id
    Comments

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

    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    276. ClinicalDocument.recordTarget.patientRole.patient.guardian.sdtcIdentifiedBy
    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
    XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
    278. ClinicalDocument.recordTarget.patientRole.patient.guardian.code
    Comments

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

    Control0..1
    BindingThe codes SHALL be taken from Personal And Legal Relationship Role Type .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
    280. 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.

    ShortBase for all types and resources
    Comments

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

    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
    Is Modifierfalse
    Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
    shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
    should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
    should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
    81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
    81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
    81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
    shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
    282. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom
    Comments

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

    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
    Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
    284. 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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    286. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value
    Control0..1
    Typeurl(url: Universal Resource Locator)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    288. 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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
    Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
    XML FormatThe type of this property is determined using the xsi:typeattribute.
    LabelUseable Period
    290. 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.

    Comments

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

    Control0..1
    BindingThe codes SHALL be taken from Telecom Use (US Realm Header) .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelUse Code
    292. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson
    Comments

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

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
    294. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.nullFlavor
    Definition

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

    Control0..1
    BindingThe codes SHALL be taken from CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    296. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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/cda/stds/core/StructureDefinition/CS
    298. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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/cda/stds/core/StructureDefinition/II
    InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
    300. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    302. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelAssigning Authority Name
    304. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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(bl: Boolean)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelDisplayable
    306. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.root
    Definition

    Identifies the type as an HL7 Registered model

    Control1..1
    Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelRoot
    Fixed Value2.16.840.1.113883.1.3
    308. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.extension
    Definition

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

    Control1..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExtension
    310. 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/cda/stds/core/StructureDefinition/II
    312. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode
    Control0..1
    BindingThe codes SHALL be taken from EntityClassLivingSubject
    (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValuePSN
    314. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode
    Control0..1
    BindingThe codes SHALL be taken from EntityDeterminer
    (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueINSTANCE
    316. 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).


    A name associated with the person.

    ShortBase for all types and resourcesA name associated with the person
    Comments

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


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

    Control10..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Person Name (PN.US.FIELDED))
    Is Modifierfalse
    Requirements

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

    Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
    81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
    81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    318. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcDesc
    Definition

    The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
    XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
    320. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship
    Definition

    Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
    XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
    322. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.nullFlavor
    Definition

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

    Control0..1
    BindingThe codes SHALL be taken from CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    324. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/CS
    326. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/II
    InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
    328. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    330. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelAssigning Authority Name
    332. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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(bl: Boolean)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelDisplayable
    334. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.root
    Definition

    Identifies the type as an HL7 Registered model

    Control1..1
    Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelRoot
    Fixed Value2.16.840.1.113883.1.3
    336. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.extension
    Definition

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

    Control1..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExtension
    338. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.templateId
    Definition

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

    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    340. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.classCode
    Control1..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValuePRS
    342. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.determinerCode
    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueINSTANCE
    344. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.code
    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
    XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
    346. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization
    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
    348. ClinicalDocument.recordTarget.patientRole.patient.birthplace
    Comments

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

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Birthplace
    350. ClinicalDocument.recordTarget.patientRole.patient.birthplace.nullFlavor
    Definition

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

    Control0..1
    BindingThe codes SHALL be taken from CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    352. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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/cda/stds/core/StructureDefinition/CS
    354. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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/cda/stds/core/StructureDefinition/II
    InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
    356. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    358. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelAssigning Authority Name
    360. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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(bl: Boolean)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelDisplayable
    362. ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.root
    Definition

    Identifies the type as an HL7 Registered model

    Control1..1
    Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelRoot
    Fixed Value2.16.840.1.113883.1.3
    364. ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.extension
    Definition

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

    Control1..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExtension
    366. 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/cda/stds/core/StructureDefinition/II
    368. ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode
    Control0..1
    BindingThe codes SHALL be taken from RoleClassPassive
    (required to http://terminology.hl7.org/ValueSet/v3-RoleClassPassive)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueBIRTHPL
    370. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place
    Comments

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

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Place
    372. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.nullFlavor
    Definition

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

    Control0..1
    BindingThe codes SHALL be taken from CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    374. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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/cda/stds/core/StructureDefinition/CS
    376. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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/cda/stds/core/StructureDefinition/II
    InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
    378. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    380. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelAssigning Authority Name
    382. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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(bl: Boolean)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelDisplayable
    384. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.root
    Definition

    Identifies the type as an HL7 Registered model

    Control1..1
    Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelRoot
    Fixed Value2.16.840.1.113883.1.3
    386. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.extension
    Definition

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

    Control1..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExtension
    388. 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/cda/stds/core/StructureDefinition/II
    390. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode
    Control0..1
    BindingThe codes SHALL be taken from EntityClassPlace
    (required to http://terminology.hl7.org/ValueSet/v3-EntityClassPlace)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValuePLC
    392. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode
    Control0..1
    BindingThe codes SHALL be taken from EntityDeterminer
    (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueINSTANCE
    394. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name
    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/EN
    396. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr
    Comments

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

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
    Invariants4537-5402: If country is US, this addr **SHALL** contain exactly one [1..1] state, which **SHALL** be selected from ValueSet US Core USPS State *DYNAMIC* (CONF:4537-5402). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
    4537-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:4537-5403). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.empty() or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
    should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
    398. 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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    400. 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(bl: Boolean)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelIs Not Ordered
    402. 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..*
    BindingThe codes SHALL be taken from CDAPostalAddressUse
    (required to http://hl7.org/cda/stds/core/ValueSet/CDAPostalAddressUse)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelUse Code
    404. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item
    Definition

    A series of items that constitute the address.

    Control0..*
    Typehttp://hl7.org/fhir/StructureDefinition/Base
    Choice GroupThis is a repeating choice group that does not appear directly in the instance
    InvariantsAD-1: Can only have only one of the possible item elements in each choice ((delimiter | country | state | county | city | postalCode | streetAddressLine | houseNumber | houseNumberNumeric | direction | streetName | streetNameBase | streetNameType | additionalLocator | unitID | unitType | careOf | censusTract | deliveryAddressLine | deliveryInstallationType | deliveryInstallationArea | deliveryInstallationQualifier | deliveryMode | deliveryModeIdentifier | buildingNumberSuffix | postBox | precinct | xmlText).count() = 1)
    406. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter
    Definition

    Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break.

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    408. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    410. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    412. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    414. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    416. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    418. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueDEL
    420. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country
    Definition

    Country

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    422. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    424. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    426. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    428. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    430. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    432. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueCNT
    434. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state
    Definition

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

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    436. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    438. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    440. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    442. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    444. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    446. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueSTA
    448. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    450. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    452. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    454. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    456. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    458. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    460. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueCPA
    462. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city
    Definition

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

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    464. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    466. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    468. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    470. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    472. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    474. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueCTY
    476. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode
    Definition

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

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    478. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    480. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    482. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    484. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    486. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    488. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueZIP
    490. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine
    Definition

    Street address line

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    492. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    494. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    496. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    498. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    500. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    502. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueSAL
    504. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    506. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    508. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    510. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    512. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    514. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    516. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueBNR
    518. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric
    Definition

    The numeric portion of a building number

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    520. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    522. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    524. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    526. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    528. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    530. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueBNN
    532. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction
    Definition

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

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    534. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    536. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    538. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    540. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    542. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    544. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueDIR
    546. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName
    Definition

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

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    548. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    550. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    552. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    554. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    556. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    558. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueSTR
    560. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase
    Definition

    The base name of a roadway or artery recognized by a municipality (excluding street type and direction)

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    562. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    564. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    566. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    568. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    570. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    572. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueSTB
    574. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType
    Definition

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

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    576. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    578. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    580. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    582. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    584. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    586. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueSTTYP
    588. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    590. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    592. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    594. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    596. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    598. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    600. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueADL
    602. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID
    Definition

    The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    604. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    606. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    608. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    610. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    612. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    614. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueUNID
    616. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType
    Definition

    Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    618. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    620. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    622. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    624. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    626. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    628. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueUNIT
    630. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    632. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    634. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    636. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    638. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    640. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    642. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueCAR
    644. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract
    Definition

    A geographic sub-unit delineated for demographic purposes.

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    646. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    648. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    650. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    652. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    654. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    656. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueCEN
    658. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    660. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    662. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    664. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    666. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    668. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    670. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueDAL
    672. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    674. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    676. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    678. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    680. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    682. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    684. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueDINST
    686. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    688. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    690. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    692. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    694. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    696. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    698. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueDINSTA
    700. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier
    Definition

    A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'.

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    702. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    704. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    706. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    708. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    710. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    712. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueDINSTQ
    714. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode
    Definition

    Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc.

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    716. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    718. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    720. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    722. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    724. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    726. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueDMOD
    728. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    730. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    732. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    734. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    736. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    738. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    740. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueDMODID
    742. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix
    Definition

    Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    744. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    746. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    748. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    750. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    752. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    754. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueBNS
    756. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox
    Definition

    A numbered box located in a post station.

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    758. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    760. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    762. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    764. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    766. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    768. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValuePOB
    770. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct
    Definition

    A subsection of a municipality

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
    Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
    772. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    774. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.representation
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueTXT
    776. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.mediaType
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelMedia Type
    Fixed Valuetext/plain
    778. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.language
    Definition

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

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelLanguage
    780. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    782. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.partType
    Definition

    Specifies the type of the address part

    Control0..1
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValuePRE
    784. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.xmlText
    ShortAllows for mixed text content
    Comments

    This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as unadorned text.
    786. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.useablePeriod
    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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
    Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
    XML FormatThe type of this property is determined using the xsi:typeattribute.
    LabelUseable Period
    788. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication
    Short𝗨𝗦𝗖𝗗𝗜: Preferred Language
    Comments

    This patient SHOULD contain zero or more [0..*] languageCommunication which SHALL be selected from ValueSet AllLanguages https://www.hl7.org/fhir/valueset-all-languages.html (OID 2.16.840.1.113883.4.642.3.21) DYNAMIC (CONF:XXX).

    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication
    Invariantsshould-proficiencyLevelCode: SHOULD contain proficiencyLevelCode (proficiencyLevelCode.exists())
    should-preferenceInd: SHOULD contain preferenceInd (preferenceInd.exists())
    790. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.nullFlavor
    Definition

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

    Control0..1
    BindingThe codes SHALL be taken from CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    792. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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/cda/stds/core/StructureDefinition/CS
    794. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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/cda/stds/core/StructureDefinition/II
    InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
    796. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    798. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelAssigning Authority Name
    800. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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(bl: Boolean)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelDisplayable
    802. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.root
    Definition

    Identifies the type as an HL7 Registered model

    Control1..1
    Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelRoot
    Fixed Value2.16.840.1.113883.1.3
    804. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.extension
    Definition

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

    Control1..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExtension
    806. 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/cda/stds/core/StructureDefinition/II
    808. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode
    Control1..1
    BindingThe codes SHALL be taken from AllLanguages
    (required to http://hl7.org/fhir/ValueSet/all-languages)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
    810. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCode
    Comments

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

    Control0..1
    BindingThe codes SHALL be taken from LanguageAbilityMode .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12249)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
    812. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode
    Comments

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

    Control0..1
    BindingThe codes SHALL be taken from LanguageAbilityProficiency .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12199)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
    814. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd
    ShortIndicates a preference for information about care delivery and treatments be communicated (or translated if needed) into this language. If more than one languageCommunication is present, only one languageCommunication element SHALL have a preferenceInd with a value of 1.
    Comments

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

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
    816. ClinicalDocument.recordTarget.patientRole.providerOrganization
    ShortIf present, this organization represents the provider organization where the person is claiming to be a patient.
    Comments

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

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
    LabelIf present, this organization represents the provider organization where the person is claiming to be a patient.
    818. ClinicalDocument.recordTarget.patientRole.providerOrganization.nullFlavor
    Definition

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

    Control0..1
    BindingThe codes SHALL be taken from CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    820. ClinicalDocument.recordTarget.patientRole.providerOrganization.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/cda/stds/core/StructureDefinition/CS
    822. ClinicalDocument.recordTarget.patientRole.providerOrganization.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/cda/stds/core/StructureDefinition/II
    InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
    824. ClinicalDocument.recordTarget.patientRole.providerOrganization.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    826. ClinicalDocument.recordTarget.patientRole.providerOrganization.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(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelAssigning Authority Name
    828. ClinicalDocument.recordTarget.patientRole.providerOrganization.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(bl: Boolean)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelDisplayable
    830. ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.root
    Definition

    Identifies the type as an HL7 Registered model

    Control1..1
    Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelRoot
    Fixed Value2.16.840.1.113883.1.3
    832. ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.extension
    Definition

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

    Control1..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExtension
    834. 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/cda/stds/core/StructureDefinition/II
    836. ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode
    Control0..1
    BindingThe codes SHALL be taken from EntityClassOrganization
    (required to http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueORG
    838. ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode
    Control0..1
    BindingThe codes SHALL be taken from EntityDeterminer
    (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueINSTANCE
    840. ClinicalDocument.recordTarget.patientRole.providerOrganization.id
    Definition

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

    ShortLogical id of this artifact
    Comments

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


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

    Control10..*1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/IIid
    Is Modifierfalse
    842. 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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    844. 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(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelAssigning Authority Name
    846. 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(bl: Boolean)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelDisplayable
    848. 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.

    Comments

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

    Control0..1
    Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelRoot
    Invariantsshould-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6')
    850. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension
    Definition

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

    Control0..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExtension
    852. ClinicalDocument.recordTarget.patientRole.providerOrganization.name
    Definition

    A name associated with the organization.

    ShortName used for the organization
    Comments

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


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

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

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    854. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom
    Comments

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

    Control1..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
    Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
    856. 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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    858. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value
    Control0..1
    Typeurl(url: Universal Resource Locator)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    860. 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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
    Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
    XML FormatThe type of this property is determined using the xsi:typeattribute.
    LabelUseable Period
    862. 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.

    Comments

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

    Control0..1
    BindingThe codes SHALL be taken from Telecom Use (US Realm Header) .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelUse Code
    864. 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.

    ShortBase for all types and resources
    Comments

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

    Control1..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
    Is Modifierfalse
    Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
    shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
    should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
    should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
    81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
    81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
    81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
    shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
    866. ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode
    Control0..1
    BindingFor example codes, see OrganizationIndustryClassNAICS
    (example to http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
    868. ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf
    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
    870. ClinicalDocument.author
    ShortThe author element represents the creator of the clinical document. The author may be a device, or a person. The person is the patient or the patient's advocate.
    Comments

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

    Control1..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
    872. 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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    874. 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/cda/stds/core/StructureDefinition/CS
    876. 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/cda/stds/core/StructureDefinition/II
    InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
    878. ClinicalDocument.author.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    880. ClinicalDocument.author.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(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelAssigning Authority Name
    882. ClinicalDocument.author.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(bl: Boolean)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelDisplayable
    884. ClinicalDocument.author.typeId.root
    Definition

    Identifies the type as an HL7 Registered model

    Control1..1
    Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelRoot
    Fixed Value2.16.840.1.113883.1.3
    886. ClinicalDocument.author.typeId.extension
    Definition

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

    Control1..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExtension
    888. 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/cda/stds/core/StructureDefinition/II
    890. ClinicalDocument.author.typeCode
    Control0..1
    BindingThe codes SHALL be taken from CDAParticipationType
    (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueAUT
    892. ClinicalDocument.author.contextControlCode
    Control0..1
    BindingThe codes SHALL be taken from CDAContextControl
    (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueOP
    894. ClinicalDocument.author.functionCode
    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
    896. 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.

    ShortBase for all types and resources
    Comments

    Such authors SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5445).

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
    Is Modifierfalse
    Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
    ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
    898. ClinicalDocument.author.assignedAuthor
    Comments

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

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor
    Invariants4537-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). ((assignedPerson | assignedAuthoringDevice).count() = 1)
    should-id-npi: SHOULD contain an id with root='2.16.840.1.113883.4.6' (NPI) (id.where(root = '2.16.840.1.113883.4.6'))
    should-us-code: SHOULD contain code (code.exists())
    should-code: SHOULD contain code (code.exists())
    900. ClinicalDocument.author.assignedAuthor.nullFlavor
    Definition

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

    Control0..1
    BindingThe codes SHALL be taken from CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    902. ClinicalDocument.author.assignedAuthor.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/cda/stds/core/StructureDefinition/CS
    904. ClinicalDocument.author.assignedAuthor.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/cda/stds/core/StructureDefinition/II
    InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
    906. ClinicalDocument.author.assignedAuthor.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExceptional Value Detail
    908. ClinicalDocument.author.assignedAuthor.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(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelAssigning Authority Name
    910. ClinicalDocument.author.assignedAuthor.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(bl: Boolean)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelDisplayable
    912. ClinicalDocument.author.assignedAuthor.typeId.root
    Definition

    Identifies the type as an HL7 Registered model

    Control1..1
    Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelRoot
    Fixed Value2.16.840.1.113883.1.3
    914. ClinicalDocument.author.assignedAuthor.typeId.extension
    Definition

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

    Control1..1
    Typestring(st: Character String)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    LabelExtension
    916. 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/cda/stds/core/StructureDefinition/II
    918. ClinicalDocument.author.assignedAuthor.classCode
    Control0..1
    BindingThe codes SHALL be taken from RoleClassAssignedEntity
    (required to http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity)
    Typecode(cs: Coded Simple Value)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueASSIGNED
    920. ClinicalDocument.author.assignedAuthor.id
    Comments

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

    Control1..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    SlicingThis element introduces a set of slices on ClinicalDocument.author.assignedAuthor.id. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ root
    • 922. ClinicalDocument.author.assignedAuthor.id:npi
      Slice Namenpi
      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
      Invariantsshould-extension: SHOULD contain extension (extension.exists())
      924. ClinicalDocument.author.assignedAuthor.id:npi.nullFlavor
      Definition

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

      ShortIf NPI is unknown, set @nullFlavor to UNK
      Control0..1
      BindingThe codes SHALL be taken from CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      926. ClinicalDocument.author.assignedAuthor.id:npi.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(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelAssigning Authority Name
      928. ClinicalDocument.author.assignedAuthor.id:npi.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(bl: Boolean)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelDisplayable
      930. ClinicalDocument.author.assignedAuthor.id:npi.root
      Definition

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

      Comments

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

      Control1..1
      Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelRoot
      Pattern Value2.16.840.1.113883.4.6
      932. ClinicalDocument.author.assignedAuthor.id:npi.extension
      Definition

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

      Comments

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

      Control0..1
      Typestring(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExtension
      934. ClinicalDocument.author.assignedAuthor.sdtcIdentifiedBy
      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
      XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
      936. ClinicalDocument.author.assignedAuthor.code
      ShortWhen the author is a person who is not acting in the role of a clinician, this code encodes the personal or legal relationship between author and the patient.
      Comments

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

      Control0..1
      BindingFor example codes, see CDARoleCode
      (example to http://hl7.org/cda/stds/core/ValueSet/CDARoleCode)
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
      938. 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..0
      BindingThe codes SHALL be taken from CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      940. 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 Personal And Legal Relationship Role Type .
      (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelCode
      942. ClinicalDocument.author.assignedAuthor.code.codeSystem
      Definition

      Specifies the code system that defines the code.

      Control0..1
      Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelCode System
      944. ClinicalDocument.author.assignedAuthor.code.codeSystemName
      Definition

      The common name of the coding system.

      Control0..1
      Typestring(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelCode System Name
      946. ClinicalDocument.author.assignedAuthor.code.codeSystemVersion
      Definition

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

      Control0..1
      Typestring(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelCode System Version
      948. 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(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelDisplay Name
      950. 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(oid: ISO Object Identifier)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn 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 namevalueSet.
      952. 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(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn 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 namevalueSetVersion.
      954. ClinicalDocument.author.assignedAuthor.code.originalText
      Definition

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

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
      LabelOriginal Text
      956. ClinicalDocument.author.assignedAuthor.code.qualifier
      Definition

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

      Control0..0
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
      LabelQualifier
      958. 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/cda/stds/core/StructureDefinition/CD
      XML FormatThe type of this property is determined using the xsi:typeattribute.
      LabelTranslation
      960. 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.

      ShortBase for all types and resources
      Comments

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

      Control1..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
      Is Modifierfalse
      Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
      shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
      should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
      should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
      81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
      81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
      81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
      shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
      962. ClinicalDocument.author.assignedAuthor.telecom
      Comments

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

      Control1..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
      Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
      964. 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 CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      966. ClinicalDocument.author.assignedAuthor.telecom.value
      Control0..1
      Typeurl(url: Universal Resource Locator)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      968. 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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
      Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
      XML FormatThe type of this property is determined using the xsi:typeattribute.
      LabelUseable Period
      970. 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.

      Comments

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

      Control0..1
      BindingThe codes SHALL be taken from Telecom Use (US Realm Header) .
      (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelUse Code
      972. ClinicalDocument.author.assignedAuthor.assignedPerson
      Comments

      MAY contain assignedPerson

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
      974. ClinicalDocument.author.assignedAuthor.assignedPerson.nullFlavor
      Definition

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

      Control0..1
      BindingThe codes SHALL be taken from CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      976. ClinicalDocument.author.assignedAuthor.assignedPerson.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/cda/stds/core/StructureDefinition/CS
      978. ClinicalDocument.author.assignedAuthor.assignedPerson.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/cda/stds/core/StructureDefinition/II
      InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
      980. ClinicalDocument.author.assignedAuthor.assignedPerson.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 CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      982. ClinicalDocument.author.assignedAuthor.assignedPerson.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(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelAssigning Authority Name
      984. ClinicalDocument.author.assignedAuthor.assignedPerson.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(bl: Boolean)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelDisplayable
      986. ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.root
      Definition

      Identifies the type as an HL7 Registered model

      Control1..1
      Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelRoot
      Fixed Value2.16.840.1.113883.1.3
      988. ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.extension
      Definition

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

      Control1..1
      Typestring(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExtension
      990. 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/cda/stds/core/StructureDefinition/II
      992. ClinicalDocument.author.assignedAuthor.assignedPerson.classCode
      Control0..1
      BindingThe codes SHALL be taken from EntityClassLivingSubject
      (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed ValuePSN
      994. ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode
      Control0..1
      BindingThe codes SHALL be taken from EntityDeterminer
      (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed ValueINSTANCE
      996. 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).


      A name associated with the person.

      ShortBase for all types and resourcesA name associated with the person
      Comments

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


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

      Control10..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Person Name (PN.US.FIELDED))
      Is Modifierfalse
      Requirements

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

      Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
      81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
      81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      998. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcDesc
      Definition

      The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
      XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
      1000. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship
      Definition

      Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
      XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
      1002. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor
      Definition

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

      Control0..1
      BindingThe codes SHALL be taken from CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      1004. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/CS
      1006. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/II
      InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
      1008. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      1010. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelAssigning Authority Name
      1012. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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(bl: Boolean)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelDisplayable
      1014. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.root
      Definition

      Identifies the type as an HL7 Registered model

      Control1..1
      Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelRoot
      Fixed Value2.16.840.1.113883.1.3
      1016. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.extension
      Definition

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

      Control1..1
      Typestring(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExtension
      1018. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.templateId
      Definition

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

      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
      1020. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.classCode
      Control1..1
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed ValuePRS
      1022. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.determinerCode
      Control0..1
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed ValueINSTANCE
      1024. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.code
      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
      XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
      1026. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice
      Comments

      MAY contain assignedAuthoringDevice

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice
      1028. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.nullFlavor
      Definition

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

      Control0..1
      BindingThe codes SHALL be taken from CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      1030. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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/cda/stds/core/StructureDefinition/CS
      1032. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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/cda/stds/core/StructureDefinition/II
      InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
      1034. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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 CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      1036. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelAssigning Authority Name
      1038. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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(bl: Boolean)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelDisplayable
      1040. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.root
      Definition

      Identifies the type as an HL7 Registered model

      Control1..1
      Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelRoot
      Fixed Value2.16.840.1.113883.1.3
      1042. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.extension
      Definition

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

      Control1..1
      Typestring(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExtension
      1044. 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/cda/stds/core/StructureDefinition/II
      1046. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode
      Control0..1
      BindingThe codes SHALL be taken from EntityClassDevice
      (required to http://terminology.hl7.org/ValueSet/v3-EntityClassDevice)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed ValueDEV
      1048. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode
      Control0..1
      BindingThe codes SHALL be taken from EntityDeterminer
      (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed ValueINSTANCE
      1050. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.code
      Control0..1
      BindingFor example codes, see CDAEntityCode
      (example to http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode)
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
      1052. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName
      Comments

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

      Control1..1
      BindingFor example codes, see Manufacturer Model Name Example
      (example to http://terminology.hl7.org/ValueSet/v3-ManufacturerModelNameExample)
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/SC
      1054. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName
      Comments

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

      Control1..1
      BindingFor example codes, see Software Name Example
      (example to http://terminology.hl7.org/ValueSet/v3-SoftwareNameExample)
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/SC
      1056. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity
      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/MaintainedEntity
      1058. ClinicalDocument.author.assignedAuthor.representedOrganization
      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
      1060. ClinicalDocument.dataEnterer
      ShortThe dataEnterer element represents the person who transferred the content, written or dictated by someone else, into the clinical document. The guiding rule of thumb is that an author provides the content found within the header or body of the document, subject to their own interpretation, and the dataEnterer adds that information to the electronic system. In other words, a dataEnterer transfers information from one source to another (e.g., transcription from paper form to electronic system). If the dataEnterer is missing, this role is assumed to be played by the author.
      Comments

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

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/DataEnterer
      1062. 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 CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      1064. 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/cda/stds/core/StructureDefinition/CS
      1066. 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/cda/stds/core/StructureDefinition/II
      InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
      1068. ClinicalDocument.dataEnterer.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 CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      1070. ClinicalDocument.dataEnterer.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(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelAssigning Authority Name
      1072. ClinicalDocument.dataEnterer.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(bl: Boolean)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelDisplayable
      1074. ClinicalDocument.dataEnterer.typeId.root
      Definition

      Identifies the type as an HL7 Registered model

      Control1..1
      Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelRoot
      Fixed Value2.16.840.1.113883.1.3
      1076. ClinicalDocument.dataEnterer.typeId.extension
      Definition

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

      Control1..1
      Typestring(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExtension
      1078. 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/cda/stds/core/StructureDefinition/II
      1080. ClinicalDocument.dataEnterer.typeCode
      Control0..1
      BindingThe codes SHALL be taken from CDAParticipationType
      (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed ValueENT
      1082. ClinicalDocument.dataEnterer.contextControlCode
      Control0..1
      BindingThe codes SHALL be taken from CDAContextControl
      (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed ValueOP
      1084. ClinicalDocument.dataEnterer.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.

      ShortBase for all types and resources
      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
      Is Modifierfalse
      Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
      ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
      1086. ClinicalDocument.dataEnterer.assignedEntity
      Comments

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

      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
      1088. ClinicalDocument.dataEnterer.assignedEntity.nullFlavor
      Definition

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

      Control0..1
      BindingThe codes SHALL be taken from CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      1090. ClinicalDocument.dataEnterer.assignedEntity.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/cda/stds/core/StructureDefinition/CS
      1092. ClinicalDocument.dataEnterer.assignedEntity.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/cda/stds/core/StructureDefinition/II
      InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
      1094. ClinicalDocument.dataEnterer.assignedEntity.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 CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      1096. ClinicalDocument.dataEnterer.assignedEntity.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(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelAssigning Authority Name
      1098. ClinicalDocument.dataEnterer.assignedEntity.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(bl: Boolean)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelDisplayable
      1100. ClinicalDocument.dataEnterer.assignedEntity.typeId.root
      Definition

      Identifies the type as an HL7 Registered model

      Control1..1
      Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelRoot
      Fixed Value2.16.840.1.113883.1.3
      1102. ClinicalDocument.dataEnterer.assignedEntity.typeId.extension
      Definition

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

      Control1..1
      Typestring(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExtension
      1104. 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/cda/stds/core/StructureDefinition/II
      1106. ClinicalDocument.dataEnterer.assignedEntity.classCode
      Control0..1
      BindingThe codes SHALL be taken from RoleClassAssignedEntity
      (required to http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed ValueASSIGNED
      1108. ClinicalDocument.dataEnterer.assignedEntity.id
      Comments

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

      Control1..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
      1110. 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 CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      1112. 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(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelAssigning Authority Name
      1114. 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(bl: Boolean)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelDisplayable
      1116. 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.

      Comments

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

      Control0..1
      Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelRoot
      Invariantsshould-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6')
      1118. ClinicalDocument.dataEnterer.assignedEntity.id.extension
      Definition

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

      Control0..1
      Typestring(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExtension
      1120. ClinicalDocument.dataEnterer.assignedEntity.sdtcIdentifiedBy
      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
      XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
      1122. ClinicalDocument.dataEnterer.assignedEntity.code
      Comments

      This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28680).

      Control0..1
      BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type .
      (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
      1124. 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.

      ShortBase for all types and resources
      Comments

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

      Control1..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
      Is Modifierfalse
      Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
      shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
      should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
      should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
      81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
      81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
      81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
      shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
      1126. ClinicalDocument.dataEnterer.assignedEntity.telecom
      Comments

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

      Control1..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
      Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
      1128. 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 CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      1130. ClinicalDocument.dataEnterer.assignedEntity.telecom.value
      Control0..1
      Typeurl(url: Universal Resource Locator)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      1132. 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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
      Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
      XML FormatThe type of this property is determined using the xsi:typeattribute.
      LabelUseable Period
      1134. 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.

      Comments

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

      Control0..1
      BindingThe codes SHALL be taken from Telecom Use (US Realm Header) .
      (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelUse Code
      1136. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson
      Comments

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

      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
      1138. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.nullFlavor
      Definition

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

      Control0..1
      BindingThe codes SHALL be taken from CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      1140. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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/cda/stds/core/StructureDefinition/CS
      1142. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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/cda/stds/core/StructureDefinition/II
      InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
      1144. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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 CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      1146. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelAssigning Authority Name
      1148. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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(bl: Boolean)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelDisplayable
      1150. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.root
      Definition

      Identifies the type as an HL7 Registered model

      Control1..1
      Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelRoot
      Fixed Value2.16.840.1.113883.1.3
      1152. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.extension
      Definition

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

      Control1..1
      Typestring(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExtension
      1154. 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/cda/stds/core/StructureDefinition/II
      1156. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode
      Control0..1
      BindingThe codes SHALL be taken from EntityClassLivingSubject
      (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed ValuePSN
      1158. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode
      Control0..1
      BindingThe codes SHALL be taken from EntityDeterminer
      (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed ValueINSTANCE
      1160. 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).


      A name associated with the person.

      ShortBase for all types and resourcesA name associated with the person
      Comments

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


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

      Control10..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Person Name (PN.US.FIELDED))
      Is Modifierfalse
      Requirements

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

      Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
      81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
      81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      1162. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcDesc
      Definition

      The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
      XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
      1164. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship
      Definition

      Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
      XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
      1166. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor
      Definition

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

      Control0..1
      BindingThe codes SHALL be taken from CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      1168. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/CS
      1170. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/II
      InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
      1172. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExceptional Value Detail
      1174. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelAssigning Authority Name
      1176. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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(bl: Boolean)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelDisplayable
      1178. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root
      Definition

      Identifies the type as an HL7 Registered model

      Control1..1
      Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelRoot
      Fixed Value2.16.840.1.113883.1.3
      1180. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension
      Definition

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

      Control1..1
      Typestring(st: Character String)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      LabelExtension
      1182. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId
      Definition

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

      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
      1184. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode
      Control1..1
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed ValuePRS
      1186. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
      Control0..1
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed ValueINSTANCE
      1188. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
      XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
      1190. ClinicalDocument.dataEnterer.assignedEntity.representedOrganization
      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
      1192. ClinicalDocument.dataEnterer.assignedEntity.sdtcPatient
      Control0..1
      Typehttp://hl7.org/fhir/StructureDefinition/Base
      XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namepatient.
      1194. ClinicalDocument.dataEnterer.assignedEntity.sdtcPatient.id
      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
      XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
      1196. ClinicalDocument.informant
      Comments

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

      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
      SlicingThis element introduces a set of slices on ClinicalDocument.informant. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • exists @ relatedEntity
      • exists @ assignedEntity
      • 1198. ClinicalDocument.informant:provider
        Slice Nameprovider
        ShortThe informant element describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient.
        Comments

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
        1200. ClinicalDocument.informant:provider.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1202. ClinicalDocument.informant:provider.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/cda/stds/core/StructureDefinition/CS
        1204. ClinicalDocument.informant:provider.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1206. ClinicalDocument.informant:provider.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1208. ClinicalDocument.informant:provider.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1210. ClinicalDocument.informant:provider.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1212. ClinicalDocument.informant:provider.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1214. ClinicalDocument.informant:provider.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1216. ClinicalDocument.informant:provider.templateId
        Definition

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        1218. ClinicalDocument.informant:provider.typeCode
        Control0..1
        BindingThe codes SHALL be taken from CDAParticipationType
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueINF
        1220. ClinicalDocument.informant:provider.contextControlCode
        Control0..1
        BindingThe codes SHALL be taken from CDAContextControl
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueOP
        1222. ClinicalDocument.informant:provider.assignedEntity
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
        1224. ClinicalDocument.informant:provider.assignedEntity.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1226. ClinicalDocument.informant:provider.assignedEntity.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/cda/stds/core/StructureDefinition/CS
        1228. ClinicalDocument.informant:provider.assignedEntity.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1230. ClinicalDocument.informant:provider.assignedEntity.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1232. ClinicalDocument.informant:provider.assignedEntity.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1234. ClinicalDocument.informant:provider.assignedEntity.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1236. ClinicalDocument.informant:provider.assignedEntity.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1238. ClinicalDocument.informant:provider.assignedEntity.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1240. ClinicalDocument.informant:provider.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/cda/stds/core/StructureDefinition/II
        1242. ClinicalDocument.informant:provider.assignedEntity.classCode
        Control0..1
        BindingThe codes SHALL be taken from RoleClassAssignedEntity
        (required to http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueASSIGNED
        1244. ClinicalDocument.informant:provider.assignedEntity.id
        ShortIf 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:4537-9946).
        Comments

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

        Control1..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        1246. ClinicalDocument.informant:provider.assignedEntity.sdtcIdentifiedBy
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
        1248. ClinicalDocument.informant:provider.assignedEntity.code
        Comments

        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:4537-32174).

        Control0..1
        BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy .
        (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        1250. ClinicalDocument.informant:provider.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.

        ShortBase for all types and resources
        Comments

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

        Control1..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
        Is Modifierfalse
        Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
        shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
        should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
        should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
        81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
        81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
        81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
        shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
        1252. ClinicalDocument.informant:provider.assignedEntity.telecom
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
        1254. ClinicalDocument.informant:provider.assignedEntity.assignedPerson
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
        1256. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1258. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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/cda/stds/core/StructureDefinition/CS
        1260. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1262. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1264. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1266. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1268. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1270. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1272. ClinicalDocument.informant:provider.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/cda/stds/core/StructureDefinition/II
        1274. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.classCode
        Control0..1
        BindingThe codes SHALL be taken from EntityClassLivingSubject
        (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValuePSN
        1276. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.determinerCode
        Control0..1
        BindingThe codes SHALL be taken from EntityDeterminer
        (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueINSTANCE
        1278. ClinicalDocument.informant:provider.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.

        ShortBase for all types and resourcesA name associated with the person
        Comments

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


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

        Control10..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Person Name (PN.US.FIELDED))
        Is Modifierfalse
        Requirements

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

        Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
        81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
        81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        1280. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcDesc
        Definition

        The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
        1282. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship
        Definition

        Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
        1284. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1286. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/CS
        1288. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1290. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1292. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1294. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1296. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1298. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1300. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId
        Definition

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        1302. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode
        Control1..1
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValuePRS
        1304. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
        Control0..1
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueINSTANCE
        1306. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
        1308. ClinicalDocument.informant:provider.assignedEntity.representedOrganization
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
        1310. ClinicalDocument.informant:provider.assignedEntity.sdtcPatient
        Control0..1
        Typehttp://hl7.org/fhir/StructureDefinition/Base
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namepatient.
        1312. ClinicalDocument.informant:provider.assignedEntity.sdtcPatient.id
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
        1314. ClinicalDocument.informant:provider.relatedEntity
        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
        1316. ClinicalDocument.informant:non-provider
        Slice Namenon-provider
        ShortThe informant element describes an information source (who is not a provider) for any content within the clinical document. This informant would be used when the source of information has a personal relationship with the patient or is the patient.
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
        1318. ClinicalDocument.informant:non-provider.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1320. ClinicalDocument.informant:non-provider.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/cda/stds/core/StructureDefinition/CS
        1322. ClinicalDocument.informant:non-provider.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1324. ClinicalDocument.informant:non-provider.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1326. ClinicalDocument.informant:non-provider.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1328. ClinicalDocument.informant:non-provider.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1330. ClinicalDocument.informant:non-provider.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1332. ClinicalDocument.informant:non-provider.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1334. ClinicalDocument.informant:non-provider.templateId
        Definition

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        1336. ClinicalDocument.informant:non-provider.typeCode
        Control0..1
        BindingThe codes SHALL be taken from CDAParticipationType
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueINF
        1338. ClinicalDocument.informant:non-provider.contextControlCode
        Control0..1
        BindingThe codes SHALL be taken from CDAContextControl
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueOP
        1340. ClinicalDocument.informant:non-provider.assignedEntity
        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
        1342. ClinicalDocument.informant:non-provider.relatedEntity
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
        1344. ClinicalDocument.informant:non-provider.relatedEntity.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1346. ClinicalDocument.informant:non-provider.relatedEntity.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/cda/stds/core/StructureDefinition/CS
        1348. ClinicalDocument.informant:non-provider.relatedEntity.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1350. ClinicalDocument.informant:non-provider.relatedEntity.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1352. ClinicalDocument.informant:non-provider.relatedEntity.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1354. ClinicalDocument.informant:non-provider.relatedEntity.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1356. ClinicalDocument.informant:non-provider.relatedEntity.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1358. ClinicalDocument.informant:non-provider.relatedEntity.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1360. ClinicalDocument.informant:non-provider.relatedEntity.templateId
        Definition

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        1362. ClinicalDocument.informant:non-provider.relatedEntity.classCode
        Control1..1
        BindingThe codes SHALL be taken from CDARoleClassMutualRelationship
        (required to http://hl7.org/cda/stds/core/ValueSet/CDARoleClassMutualRelationship)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        1364. ClinicalDocument.informant:non-provider.relatedEntity.code
        Comments

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

        Control0..1
        BindingFor example codes, see PersonalRelationshipRoleType
        (example to http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        Invariantsshould-us-code-attr: SHOULD contain @code (code.exists())
        1366. ClinicalDocument.informant:non-provider.relatedEntity.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1368. ClinicalDocument.informant:non-provider.relatedEntity.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.

        Comments

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

        Control0..1
        BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type .
        (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode
        1370. ClinicalDocument.informant:non-provider.relatedEntity.code.codeSystem
        Definition

        Specifies the code system that defines the code.

        Control0..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System
        1372. ClinicalDocument.informant:non-provider.relatedEntity.code.codeSystemName
        Definition

        The common name of the coding system.

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Name
        1374. ClinicalDocument.informant:non-provider.relatedEntity.code.codeSystemVersion
        Definition

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

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Version
        1376. ClinicalDocument.informant:non-provider.relatedEntity.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplay Name
        1378. ClinicalDocument.informant:non-provider.relatedEntity.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(oid: ISO Object Identifier)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn 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 namevalueSet.
        1380. ClinicalDocument.informant:non-provider.relatedEntity.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn 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 namevalueSetVersion.
        1382. ClinicalDocument.informant:non-provider.relatedEntity.code.originalText
        Definition

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

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        LabelOriginal Text
        1384. ClinicalDocument.informant:non-provider.relatedEntity.code.qualifier
        Definition

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

        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
        LabelQualifier
        1386. ClinicalDocument.informant:non-provider.relatedEntity.code.translation
        Definition

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        LabelTranslation
        1388. ClinicalDocument.informant:non-provider.relatedEntity.addr
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
        1390. ClinicalDocument.informant:non-provider.relatedEntity.telecom
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
        1392. ClinicalDocument.informant:non-provider.relatedEntity.effectiveTime
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
        1394. ClinicalDocument.informant:non-provider.relatedEntity.relatedPerson
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
        1396. ClinicalDocument.custodian
        ShortThe custodian element represents the organization or person that is in charge of maintaining the document. The custodian is the steward that is entrusted with the care of the document. Every CDA document has exactly one custodian. The custodian participation satisfies the CDA definition of Stewardship. Because CDA is an exchange standard and may not represent the original form of the authenticated document (e.g., CDA could include scanned copy of original), the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party. Also, the custodian may be the patient or an organization acting on behalf of the patient, such as a PHR organization.
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Custodian
        1398. 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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1400. 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/cda/stds/core/StructureDefinition/CS
        1402. 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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1404. ClinicalDocument.custodian.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1406. ClinicalDocument.custodian.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1408. ClinicalDocument.custodian.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1410. ClinicalDocument.custodian.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1412. ClinicalDocument.custodian.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1414. 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/cda/stds/core/StructureDefinition/II
        1416. ClinicalDocument.custodian.typeCode
        Control0..1
        BindingThe codes SHALL be taken from CDAParticipationType
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueCST
        1418. ClinicalDocument.custodian.assignedCustodian
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedCustodian
        1420. ClinicalDocument.custodian.assignedCustodian.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1422. ClinicalDocument.custodian.assignedCustodian.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/cda/stds/core/StructureDefinition/CS
        1424. ClinicalDocument.custodian.assignedCustodian.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1426. ClinicalDocument.custodian.assignedCustodian.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1428. ClinicalDocument.custodian.assignedCustodian.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1430. ClinicalDocument.custodian.assignedCustodian.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1432. ClinicalDocument.custodian.assignedCustodian.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1434. ClinicalDocument.custodian.assignedCustodian.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1436. 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/cda/stds/core/StructureDefinition/II
        1438. ClinicalDocument.custodian.assignedCustodian.classCode
        Control0..1
        BindingThe codes SHALL be taken from RoleClassAssignedEntity
        (required to http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueASSIGNED
        1440. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
        ShortThe representedCustodianOrganization may be the person when the document is not maintained by an organization.
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CustodianOrganization
        1442. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1444. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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/cda/stds/core/StructureDefinition/CS
        1446. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1448. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1450. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1452. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1454. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1456. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1458. 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/cda/stds/core/StructureDefinition/II
        1460. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode
        Control0..1
        BindingThe codes SHALL be taken from EntityClassOrganization
        (required to http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueORG
        1462. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode
        Control0..1
        BindingThe codes SHALL be taken from EntityDeterminer
        (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueINSTANCE
        1464. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
        ShortThe combined @root and @extension attributes record the custodian organization's identity in a secure, trusted, and unique way.
        Comments

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

        Control1..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        1466. 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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1468. 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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1470. 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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1472. 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.

        Comments

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

        Control0..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Invariantsshould-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6')
        1474. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.extension
        Definition

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

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1476. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ON
        1478. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
        Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
        1480. 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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1482. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.value
        Control0..1
        Typeurl(url: Universal Resource Locator)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        1484. 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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
        Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        LabelUseable Period
        1486. 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.

        Comments

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

        Control0..1
        BindingThe codes SHALL be taken from Telecom Use (US Realm Header) .
        (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelUse Code
        1488. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.sdtcTelecom
        ShortThe stdc:telecom extension can be used to provide additional telecom elements for the custodian organization.
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nametelecom.
        1490. 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.

        ShortBase for all types and resources
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
        Is Modifierfalse
        Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
        shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
        should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
        should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
        81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
        81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
        81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
        shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
        1492. ClinicalDocument.informationRecipient
        ShortThe informationRecipient element records the intended recipient of the information at the time the document is created. For example, in cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to be the scoping organization for that chart.
        Comments

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient
        1494. 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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1496. 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/cda/stds/core/StructureDefinition/CS
        1498. 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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1500. ClinicalDocument.informationRecipient.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1502. ClinicalDocument.informationRecipient.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1504. ClinicalDocument.informationRecipient.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1506. ClinicalDocument.informationRecipient.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1508. ClinicalDocument.informationRecipient.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1510. 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/cda/stds/core/StructureDefinition/II
        1512. ClinicalDocument.informationRecipient.typeCode
        Control0..1
        BindingThe codes SHALL be taken from XInformationRecipient (2.0.0)
        (required to http://terminology.hl7.org/ValueSet/v3-xInformationRecipient|2.0.0)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Default ValuePRCP
        1514. ClinicalDocument.informationRecipient.intendedRecipient
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IntendedRecipient
        Invariantsshould-id: SHOULD contain id (id.exists())
        1516. ClinicalDocument.informationRecipient.intendedRecipient.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1518. ClinicalDocument.informationRecipient.intendedRecipient.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/cda/stds/core/StructureDefinition/CS
        1520. ClinicalDocument.informationRecipient.intendedRecipient.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1522. ClinicalDocument.informationRecipient.intendedRecipient.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1524. ClinicalDocument.informationRecipient.intendedRecipient.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1526. ClinicalDocument.informationRecipient.intendedRecipient.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1528. ClinicalDocument.informationRecipient.intendedRecipient.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1530. ClinicalDocument.informationRecipient.intendedRecipient.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1532. 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/cda/stds/core/StructureDefinition/II
        1534. ClinicalDocument.informationRecipient.intendedRecipient.classCode
        Control0..1
        BindingThe codes SHALL be taken from CDAInformationRecipientRole
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAInformationRecipientRole)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Default ValueASSIGNED
        1536. ClinicalDocument.informationRecipient.intendedRecipient.id
        ShortThe combined @root and @extension attributes to record the information recipient's identity in a secure, trusted, and unique way.
        Comments

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        Invariantsshould-root: SHOULD contain @root (root.exists())
        1538. ClinicalDocument.informationRecipient.intendedRecipient.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1540. ClinicalDocument.informationRecipient.intendedRecipient.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1542. ClinicalDocument.informationRecipient.intendedRecipient.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1544. ClinicalDocument.informationRecipient.intendedRecipient.id.root
        Definition

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

        ShortFor a provider, the id/@root ="2.16.840.1.113883.4.6" indicates the National Provider Identifier where id/@extension is the NPI number for the provider. The ids MAY reference the id of a person or organization entity specified elsewhere in the document.
        Comments

        The id, if present, SHOULD contain zero or one [0..1] @root (CONF:1198-28693).

        Control0..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        1546. ClinicalDocument.informationRecipient.intendedRecipient.id.extension
        Definition

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

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1548. ClinicalDocument.informationRecipient.intendedRecipient.sdtcIdentifiedBy
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
        1550. ClinicalDocument.informationRecipient.intendedRecipient.addr
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
        1552. ClinicalDocument.informationRecipient.intendedRecipient.telecom
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
        1554. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient
        Comments

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

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
        1556. ClinicalDocument.informationRecipient.intendedRecipient.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1558. ClinicalDocument.informationRecipient.intendedRecipient.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/cda/stds/core/StructureDefinition/CS
        1560. ClinicalDocument.informationRecipient.intendedRecipient.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1562. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1564. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1566. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1568. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1570. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1572. 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/cda/stds/core/StructureDefinition/II
        1574. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode
        Control0..1
        BindingThe codes SHALL be taken from EntityClassLivingSubject
        (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValuePSN
        1576. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode
        Control0..1
        BindingThe codes SHALL be taken from EntityDeterminer
        (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueINSTANCE
        1578. 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).


        A name associated with the person.

        ShortBase for all types and resourcesA name associated with the person
        Comments

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


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

        Control10..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Person Name (PN.US.FIELDED))
        Is Modifierfalse
        Requirements

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

        Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
        81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
        81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        1580. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcDesc
        Definition

        The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
        1582. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship
        Definition

        Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
        1584. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1586. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/CS
        1588. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1590. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1592. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1594. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1596. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1598. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1600. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.templateId
        Definition

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        1602. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.classCode
        Control1..1
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValuePRS
        1604. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.determinerCode
        Control0..1
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueINSTANCE
        1606. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.code
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
        1608. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization
        Comments

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

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
        1610. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1612. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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/cda/stds/core/StructureDefinition/CS
        1614. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1616. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1618. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1620. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1622. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1624. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1626. 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/cda/stds/core/StructureDefinition/II
        1628. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode
        Control0..1
        BindingThe codes SHALL be taken from EntityClassOrganization
        (required to http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueORG
        1630. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode
        Control0..1
        BindingThe codes SHALL be taken from EntityDeterminer
        (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueINSTANCE
        1632. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id
        Definition

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

        ShortLogical id of this artifact
        Comments

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

        Control0..*1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IIid
        Is Modifierfalse
        1634. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name
        Definition

        A name associated with the organization.

        ShortName used for the organization
        Comments

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


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

        Control10..1
        This element is affected by the following invariants: org-1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ONstring
        Is Modifierfalse
        Requirements

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        1636. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
        1638. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
        1640. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCode
        Control0..1
        BindingFor example codes, see OrganizationIndustryClassNAICS
        (example to http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        1642. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
        1644. ClinicalDocument.legalAuthenticator
        ShortIn a patient authored document, the legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. (Note that per the following section, there may also be one or more document authenticators.) Based on local practice, patient authored documents may be provided without legal authentication. This implies that a patient authored document that does not contain this element has not been legally authenticated. The act of legal authentication requires a certain privilege be granted to the legal authenticator depending upon local policy. All patient documents have the potential for legal authentication, given the appropriate legal authority. Local policies MAY choose to delegate the function of legal authentication to a device or system that generates the document. In these cases, the legal authenticator is the person accepting responsibility for the document, not the generating device or system. Note that the legal authenticator, if present, must be a person.
        Comments

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

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator
        1646. 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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1648. 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/cda/stds/core/StructureDefinition/CS
        1650. 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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1652. ClinicalDocument.legalAuthenticator.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1654. ClinicalDocument.legalAuthenticator.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1656. ClinicalDocument.legalAuthenticator.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1658. ClinicalDocument.legalAuthenticator.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1660. ClinicalDocument.legalAuthenticator.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1662. 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/cda/stds/core/StructureDefinition/II
        1664. ClinicalDocument.legalAuthenticator.typeCode
        Control0..1
        BindingThe codes SHALL be taken from CDAParticipationType
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueLA
        1666. ClinicalDocument.legalAuthenticator.contextControlCode
        Control0..1
        BindingThe codes SHALL be taken from CDAContextControl
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueOP
        1668. 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.

        ShortBase for all types and resources
        Comments

        The legalAuthenticator, if present, SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5580).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
        Is Modifierfalse
        Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
        ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
        1670. ClinicalDocument.legalAuthenticator.signatureCode
        Comments

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

        Control1..1
        BindingThe codes SHALL be taken from CDASignatureCode
        (required to http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
        Invariantssignature: CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. (code.exists() implies code != 'X')
        1672. 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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1674. 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.

        Comments

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

        Control1..1
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode
        Pattern ValueS
        1676. ClinicalDocument.legalAuthenticator.signatureCode.codeSystem
        Definition

        Specifies the code system that defines the code.

        Control0..0
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System
        1678. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemName
        Definition

        The common name of the coding system.

        Control0..0
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Name
        1680. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemVersion
        Definition

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

        Control0..0
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Version
        1682. 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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplay Name
        1684. 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(oid: ISO Object Identifier)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn 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 namevalueSet.
        1686. 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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn 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 namevalueSetVersion.
        1688. ClinicalDocument.legalAuthenticator.signatureCode.originalText
        Definition

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

        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        LabelOriginal Text
        1690. ClinicalDocument.legalAuthenticator.signatureCode.qualifier
        Definition

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

        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
        LabelQualifier
        1692. 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/cda/stds/core/StructureDefinition/CD
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        LabelTranslation
        1694. ClinicalDocument.legalAuthenticator.sdtcSignatureText
        Definition

        A textual or multimedia depiction of the signature by which the participant endorses his or her participation in the Act as specified in the Participation.typeCode and that he or she agrees to assume the associated accountability.

        ShortThe signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall 2013.
        Comments

        The legalAuthenticator, if present, MAY contain zero or one [0..1] sdtc:signatureText (CONF:4537-30810).

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namesignatureText.
        1696. ClinicalDocument.legalAuthenticator.assignedEntity
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
        1698. ClinicalDocument.legalAuthenticator.assignedEntity.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1700. ClinicalDocument.legalAuthenticator.assignedEntity.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/cda/stds/core/StructureDefinition/CS
        1702. ClinicalDocument.legalAuthenticator.assignedEntity.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1704. ClinicalDocument.legalAuthenticator.assignedEntity.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1706. ClinicalDocument.legalAuthenticator.assignedEntity.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1708. ClinicalDocument.legalAuthenticator.assignedEntity.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1710. ClinicalDocument.legalAuthenticator.assignedEntity.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1712. ClinicalDocument.legalAuthenticator.assignedEntity.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1714. 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/cda/stds/core/StructureDefinition/II
        1716. ClinicalDocument.legalAuthenticator.assignedEntity.classCode
        Control0..1
        BindingThe codes SHALL be taken from RoleClassAssignedEntity
        (required to http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueASSIGNED
        1718. ClinicalDocument.legalAuthenticator.assignedEntity.id
        ShortThe combined @root and @extension attributes to record the information recipient's identity in a secure, trusted, and unique way.
        Comments

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

        Control1..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        1720. 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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1722. 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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1724. 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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1726. 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.

        ShortMAY contain '2.16.840.1.113883.4.6' (NPI)
        Comments

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

        Control0..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        1728. ClinicalDocument.legalAuthenticator.assignedEntity.id.extension
        Definition

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

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1730. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcIdentifiedBy
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
        1732. ClinicalDocument.legalAuthenticator.assignedEntity.code
        Comments

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

        Control0..1
        BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy .
        (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        1734. ClinicalDocument.legalAuthenticator.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1736. ClinicalDocument.legalAuthenticator.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.

        Comments

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

        Control0..1
        BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type .
        (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode
        1738. ClinicalDocument.legalAuthenticator.assignedEntity.code.codeSystem
        Definition

        Specifies the code system that defines the code.

        Control0..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System
        1740. ClinicalDocument.legalAuthenticator.assignedEntity.code.codeSystemName
        Definition

        The common name of the coding system.

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Name
        1742. ClinicalDocument.legalAuthenticator.assignedEntity.code.codeSystemVersion
        Definition

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

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Version
        1744. ClinicalDocument.legalAuthenticator.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplay Name
        1746. ClinicalDocument.legalAuthenticator.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(oid: ISO Object Identifier)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn 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 namevalueSet.
        1748. ClinicalDocument.legalAuthenticator.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn 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 namevalueSetVersion.
        1750. ClinicalDocument.legalAuthenticator.assignedEntity.code.originalText
        Definition

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

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        LabelOriginal Text
        1752. ClinicalDocument.legalAuthenticator.assignedEntity.code.qualifier
        Definition

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

        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
        LabelQualifier
        1754. ClinicalDocument.legalAuthenticator.assignedEntity.code.translation
        Definition

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        LabelTranslation
        1756. 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.

        ShortBase for all types and resources
        Comments

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

        Control1..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
        Is Modifierfalse
        Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
        shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
        should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
        should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
        81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
        81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
        81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
        shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
        1758. ClinicalDocument.legalAuthenticator.assignedEntity.telecom
        Comments

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

        Control1..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
        Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
        1760. 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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1762. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.value
        Control0..1
        Typeurl(url: Universal Resource Locator)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        1764. 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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
        Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        LabelUseable Period
        1766. 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.

        Comments

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

        Control0..1
        BindingThe codes SHALL be taken from Telecom Use (US Realm Header) .
        (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelUse Code
        1768. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
        1770. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1772. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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/cda/stds/core/StructureDefinition/CS
        1774. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1776. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1778. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1780. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1782. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1784. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1786. 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/cda/stds/core/StructureDefinition/II
        1788. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode
        Control0..1
        BindingThe codes SHALL be taken from EntityClassLivingSubject
        (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValuePSN
        1790. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode
        Control0..1
        BindingThe codes SHALL be taken from EntityDeterminer
        (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueINSTANCE
        1792. 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).


        A name associated with the person.

        ShortBase for all types and resourcesA name associated with the person
        Comments

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


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

        Control10..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Person Name (PN.US.FIELDED))
        Is Modifierfalse
        Requirements

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

        Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
        81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
        81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        1794. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcDesc
        Definition

        The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
        1796. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship
        Definition

        Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
        1798. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1800. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/CS
        1802. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1804. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1806. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1808. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1810. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1812. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1814. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId
        Definition

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        1816. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode
        Control1..1
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValuePRS
        1818. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
        Control0..1
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueINSTANCE
        1820. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
        1822. ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
        1824. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcPatient
        Control0..1
        Typehttp://hl7.org/fhir/StructureDefinition/Base
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namepatient.
        1826. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcPatient.id
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
        1828. ClinicalDocument.authenticator
        ShortThe authenticator identifies a participant or participants who attest to the accuracy of the information in the document.
        Comments

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authenticator
        1830. ClinicalDocument.authenticator.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1832. ClinicalDocument.authenticator.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/cda/stds/core/StructureDefinition/CS
        1834. ClinicalDocument.authenticator.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1836. ClinicalDocument.authenticator.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1838. ClinicalDocument.authenticator.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1840. ClinicalDocument.authenticator.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1842. ClinicalDocument.authenticator.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1844. ClinicalDocument.authenticator.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1846. ClinicalDocument.authenticator.templateId
        Definition

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        1848. ClinicalDocument.authenticator.typeCode
        Control0..1
        BindingThe codes SHALL be taken from CDAParticipationType
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueAUTHEN
        1850. ClinicalDocument.authenticator.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.

        ShortBase for all types and resources
        Comments

        SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5608).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
        Is Modifierfalse
        Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
        ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
        1852. ClinicalDocument.authenticator.signatureCode
        Comments

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

        Control1..1
        BindingThe codes SHALL be taken from CDASignatureCode
        (required to http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
        Invariantssignature: CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. (code.exists() implies code != 'X')
        1854. ClinicalDocument.authenticator.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1856. ClinicalDocument.authenticator.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.

        Comments

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

        Control1..1
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode
        Pattern ValueS
        1858. ClinicalDocument.authenticator.signatureCode.codeSystem
        Definition

        Specifies the code system that defines the code.

        Control0..0
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System
        1860. ClinicalDocument.authenticator.signatureCode.codeSystemName
        Definition

        The common name of the coding system.

        Control0..0
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Name
        1862. ClinicalDocument.authenticator.signatureCode.codeSystemVersion
        Definition

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

        Control0..0
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Version
        1864. ClinicalDocument.authenticator.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplay Name
        1866. ClinicalDocument.authenticator.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(oid: ISO Object Identifier)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn 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 namevalueSet.
        1868. ClinicalDocument.authenticator.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn 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 namevalueSetVersion.
        1870. ClinicalDocument.authenticator.signatureCode.originalText
        Definition

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

        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        LabelOriginal Text
        1872. ClinicalDocument.authenticator.signatureCode.qualifier
        Definition

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

        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
        LabelQualifier
        1874. ClinicalDocument.authenticator.signatureCode.translation
        Definition

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

        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        LabelTranslation
        1876. ClinicalDocument.authenticator.sdtcSignatureText
        Definition

        A textual or multimedia depiction of the signature by which the participant endorses his or her participation in the Act as specified in the Participation.typeCode and that he or she agrees to assume the associated accountability.

        ShortThe signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall of 2013.
        Comments

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

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namesignatureText.
        1878. ClinicalDocument.authenticator.assignedEntity
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
        Invariantsshould-code: SHOULD contain code (code.exists())
        1880. ClinicalDocument.authenticator.assignedEntity.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1882. ClinicalDocument.authenticator.assignedEntity.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/cda/stds/core/StructureDefinition/CS
        1884. ClinicalDocument.authenticator.assignedEntity.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1886. ClinicalDocument.authenticator.assignedEntity.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1888. ClinicalDocument.authenticator.assignedEntity.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1890. ClinicalDocument.authenticator.assignedEntity.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1892. ClinicalDocument.authenticator.assignedEntity.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1894. ClinicalDocument.authenticator.assignedEntity.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1896. ClinicalDocument.authenticator.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/cda/stds/core/StructureDefinition/II
        1898. ClinicalDocument.authenticator.assignedEntity.classCode
        Control0..1
        BindingThe codes SHALL be taken from RoleClassAssignedEntity
        (required to http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueASSIGNED
        1900. ClinicalDocument.authenticator.assignedEntity.id
        ShortThe combined @root and @extension attributes to record the authenticator's identity in a secure, trusted, and unique way.
        Comments

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

        Control1..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        1902. ClinicalDocument.authenticator.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1904. ClinicalDocument.authenticator.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1906. ClinicalDocument.authenticator.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1908. ClinicalDocument.authenticator.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.

        Comments

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

        Control0..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Invariantsshould-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6')
        1910. ClinicalDocument.authenticator.assignedEntity.id.extension
        Definition

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

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1912. ClinicalDocument.authenticator.assignedEntity.sdtcIdentifiedBy
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
        1914. ClinicalDocument.authenticator.assignedEntity.code
        Comments

        This assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28702).

        Control0..1
        BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type .
        (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        1916. ClinicalDocument.authenticator.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1918. ClinicalDocument.authenticator.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.

        Comments

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

        Control0..1
        BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy .
        (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode
        1920. ClinicalDocument.authenticator.assignedEntity.code.codeSystem
        Definition

        Specifies the code system that defines the code.

        Control0..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System
        1922. ClinicalDocument.authenticator.assignedEntity.code.codeSystemName
        Definition

        The common name of the coding system.

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Name
        1924. ClinicalDocument.authenticator.assignedEntity.code.codeSystemVersion
        Definition

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

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Version
        1926. ClinicalDocument.authenticator.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplay Name
        1928. ClinicalDocument.authenticator.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(oid: ISO Object Identifier)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn 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 namevalueSet.
        1930. ClinicalDocument.authenticator.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn 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 namevalueSetVersion.
        1932. ClinicalDocument.authenticator.assignedEntity.code.originalText
        Definition

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

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        LabelOriginal Text
        1934. ClinicalDocument.authenticator.assignedEntity.code.qualifier
        Definition

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

        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
        LabelQualifier
        1936. ClinicalDocument.authenticator.assignedEntity.code.translation
        Definition

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        LabelTranslation
        1938. ClinicalDocument.authenticator.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.

        ShortBase for all types and resources
        Comments

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

        Control1..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
        Is Modifierfalse
        Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
        shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
        should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
        should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
        81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
        81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
        81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
        shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
        1940. ClinicalDocument.authenticator.assignedEntity.telecom
        Comments

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

        Control1..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
        Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
        1942. ClinicalDocument.authenticator.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1944. ClinicalDocument.authenticator.assignedEntity.telecom.value
        Control0..1
        Typeurl(url: Universal Resource Locator)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        1946. ClinicalDocument.authenticator.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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
        Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        LabelUseable Period
        1948. ClinicalDocument.authenticator.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.

        Comments

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

        Control0..1
        BindingThe codes SHALL be taken from Telecom Use (US Realm Header) .
        (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelUse Code
        1950. ClinicalDocument.authenticator.assignedEntity.assignedPerson
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
        1952. ClinicalDocument.authenticator.assignedEntity.assignedPerson.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1954. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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/cda/stds/core/StructureDefinition/CS
        1956. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1958. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1960. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1962. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1964. ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1966. ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1968. ClinicalDocument.authenticator.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/cda/stds/core/StructureDefinition/II
        1970. ClinicalDocument.authenticator.assignedEntity.assignedPerson.classCode
        Control0..1
        BindingThe codes SHALL be taken from EntityClassLivingSubject
        (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValuePSN
        1972. ClinicalDocument.authenticator.assignedEntity.assignedPerson.determinerCode
        Control0..1
        BindingThe codes SHALL be taken from EntityDeterminer
        (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueINSTANCE
        1974. ClinicalDocument.authenticator.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.

        ShortBase for all types and resourcesA name associated with the person
        Comments

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


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

        Control10..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Person Name (PN.US.FIELDED))
        Is Modifierfalse
        Requirements

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

        Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
        81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
        81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        1976. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcDesc
        Definition

        The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
        1978. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship
        Definition

        Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
        1980. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1982. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/CS
        1984. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        1986. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        1988. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        1990. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        1992. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        1994. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        1996. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId
        Definition

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        1998. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode
        Control1..1
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValuePRS
        2000. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
        Control0..1
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueINSTANCE
        2002. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
        2004. ClinicalDocument.authenticator.assignedEntity.representedOrganization
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
        2006. ClinicalDocument.authenticator.assignedEntity.sdtcPatient
        Control0..1
        Typehttp://hl7.org/fhir/StructureDefinition/Base
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namepatient.
        2008. ClinicalDocument.authenticator.assignedEntity.sdtcPatient.id
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
        2010. ClinicalDocument.participant
        ShortThe participant element identifies other supporting participants, including parents, relatives, caregivers, insurance policyholders, guarantors, and other participants related in some way to the patient. A supporting person or organization is an individual or an organization with a relationship to the patient. A supporting person who is playing multiple roles would be recorded in multiple participants (e.g., emergency contact and next-of-kin)
        Comments

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant1
        Invariants4537-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). (associatedEntity.associatedPerson.exists() or associatedEntity.scopingOrganization.exists())
        4537-10007: When participant/@typeCode is *IND*, associatedEntity/@classCode **SHOULD** be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *DYNAMIC* (CONF:4537-10007). (typeCode = 'IND' implies associatedEntity.classCode.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.33'))
        2012. ClinicalDocument.participant.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2014. ClinicalDocument.participant.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/cda/stds/core/StructureDefinition/CS
        2016. ClinicalDocument.participant.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        2018. ClinicalDocument.participant.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2020. ClinicalDocument.participant.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        2022. ClinicalDocument.participant.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        2024. ClinicalDocument.participant.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        2026. ClinicalDocument.participant.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        2028. ClinicalDocument.participant.templateId
        Definition

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        2030. ClinicalDocument.participant.typeCode
        ShortUnless otherwise specified by the document specific header constraints, when participant/@typeCode is IND, associatedEntity/@classCode SHALL be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes STATIC 2011-09-30
        Comments

        The participant, if present, SHALL contain exactly one [1..1] @typeCode (CONF:1198-28704).

        Control1..1
        BindingThe codes SHALL be taken from CDAParticipationType
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        2032. ClinicalDocument.participant.contextControlCode
        Control0..1
        BindingThe codes SHALL be taken from CDAContextControl
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueOP
        2034. ClinicalDocument.participant.functionCode
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        2036. ClinicalDocument.participant.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.

        ShortBase for all types and resources
        Comments

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

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
        Is Modifierfalse
        Invariantsivl-ts-center: Center cannot co-exist with low or high (center.empty() or (low.empty() and high.empty()))
        ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. (value.exists() implies value.toString().length() >= 10)
        ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component. (value.exists() implies value.toString().length() > 10)
        2038. ClinicalDocument.participant.associatedEntity
        Comments

        The participant, if present, SHALL contain exactly one [1..1] associatedEntity (CONF:1198-28705).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
        Invariantsshould-code: SHOULD contain code (code.exists())
        2040. ClinicalDocument.participant.associatedEntity.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2042. ClinicalDocument.participant.associatedEntity.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/cda/stds/core/StructureDefinition/CS
        2044. ClinicalDocument.participant.associatedEntity.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        2046. ClinicalDocument.participant.associatedEntity.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2048. ClinicalDocument.participant.associatedEntity.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        2050. ClinicalDocument.participant.associatedEntity.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        2052. ClinicalDocument.participant.associatedEntity.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        2054. ClinicalDocument.participant.associatedEntity.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        2056. ClinicalDocument.participant.associatedEntity.templateId
        Definition

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        2058. ClinicalDocument.participant.associatedEntity.classCode
        Control1..1
        BindingThe codes SHALL be taken from CDARoleClassAssociative
        (required to http://hl7.org/cda/stds/core/ValueSet/CDARoleClassAssociative)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        2060. ClinicalDocument.participant.associatedEntity.id
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        2062. ClinicalDocument.participant.associatedEntity.sdtcIdentifiedBy
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
        2064. ClinicalDocument.participant.associatedEntity.code
        Comments

        This associatedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28706).

        Control0..1
        BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type .
        (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        2066. ClinicalDocument.participant.associatedEntity.addr
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
        2068. ClinicalDocument.participant.associatedEntity.telecom
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
        2070. ClinicalDocument.participant.associatedEntity.associatedPerson
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
        2072. ClinicalDocument.participant.associatedEntity.scopingOrganization
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
        2074. ClinicalDocument.inFulfillmentOf
        ShortThe inFulfillmentOf element represents orders that are fulfilled by this document such as a radiologists' report of an x-ray.
        Comments

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf
        2076. 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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2078. 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/cda/stds/core/StructureDefinition/CS
        2080. 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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        2082. ClinicalDocument.inFulfillmentOf.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2084. ClinicalDocument.inFulfillmentOf.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        2086. ClinicalDocument.inFulfillmentOf.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        2088. ClinicalDocument.inFulfillmentOf.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        2090. ClinicalDocument.inFulfillmentOf.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        2092. 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/cda/stds/core/StructureDefinition/II
        2094. ClinicalDocument.inFulfillmentOf.typeCode
        Control0..1
        BindingThe codes SHALL be taken from ActRelationshipFulfills (2.0.0)
        (required to http://terminology.hl7.org/ValueSet/v3-ActRelationshipFulfills|2.0.0)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueFLFS
        2096. ClinicalDocument.inFulfillmentOf.order
        Comments

        The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:1198-28708).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Order
        2098. ClinicalDocument.inFulfillmentOf.order.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2100. ClinicalDocument.inFulfillmentOf.order.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/cda/stds/core/StructureDefinition/CS
        2102. ClinicalDocument.inFulfillmentOf.order.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        2104. ClinicalDocument.inFulfillmentOf.order.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2106. ClinicalDocument.inFulfillmentOf.order.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        2108. ClinicalDocument.inFulfillmentOf.order.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        2110. ClinicalDocument.inFulfillmentOf.order.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        2112. ClinicalDocument.inFulfillmentOf.order.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        2114. 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/cda/stds/core/StructureDefinition/II
        2116. ClinicalDocument.inFulfillmentOf.order.classCode
        Control0..1
        BindingThe codes SHALL be taken from CDAActClass
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Default ValueACT
        2118. ClinicalDocument.inFulfillmentOf.order.moodCode
        Control0..1
        BindingThe codes SHALL be taken from CDAActMoodIntent
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAActMoodIntent)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueRQO
        2120. ClinicalDocument.inFulfillmentOf.order.id
        ShortA scheduled appointment or service event in a practice management system may be represented using this id element.
        Comments

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

        Control1..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        2122. ClinicalDocument.inFulfillmentOf.order.code
        Control0..1
        BindingFor example codes, see v3 Code System ActCode
        (example to http://terminology.hl7.org/ValueSet/v3-ActCode)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        2124. ClinicalDocument.inFulfillmentOf.order.priorityCode
        Control0..1
        BindingFor example codes, see ActPriority
        (example to http://terminology.hl7.org/ValueSet/v3-ActPriority)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        2126. ClinicalDocument.documentationOf
        Comments

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf
        2128. 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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2130. 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/cda/stds/core/StructureDefinition/CS
        2132. 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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        2134. ClinicalDocument.documentationOf.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2136. ClinicalDocument.documentationOf.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        2138. ClinicalDocument.documentationOf.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        2140. ClinicalDocument.documentationOf.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        2142. ClinicalDocument.documentationOf.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        2144. 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/cda/stds/core/StructureDefinition/II
        2146. ClinicalDocument.documentationOf.typeCode
        Control0..1
        BindingThe codes SHALL be taken from CDAActRelationshipType
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueDOC
        2148. ClinicalDocument.documentationOf.serviceEvent
        ShortA serviceEvent represents the main act being documented, such as a colonoscopy or a cardiac stress study. In a provision of healthcare serviceEvent, the care providers, PCP, or other longitudinal providers, are recorded within the serviceEvent. If the document is about a single encounter, the providers associated can be recorded in the componentOf/encompassingEncounter template.
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent
        Invariantsshould-us-performer: SHOULD contain performer (performer.exists())
        should-code: SHOULD contain code (code.exists())
        should-performer: SHOULD contain performer (performer.exists())
        2150. ClinicalDocument.documentationOf.serviceEvent.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2152. ClinicalDocument.documentationOf.serviceEvent.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/cda/stds/core/StructureDefinition/CS
        2154. ClinicalDocument.documentationOf.serviceEvent.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        2156. ClinicalDocument.documentationOf.serviceEvent.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2158. ClinicalDocument.documentationOf.serviceEvent.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        2160. ClinicalDocument.documentationOf.serviceEvent.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        2162. ClinicalDocument.documentationOf.serviceEvent.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        2164. ClinicalDocument.documentationOf.serviceEvent.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        2166. 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/cda/stds/core/StructureDefinition/II
        2168. ClinicalDocument.documentationOf.serviceEvent.classCode
        Control0..1
        BindingThe codes SHALL be taken from CDAActClass
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Default ValueACT
        2170. ClinicalDocument.documentationOf.serviceEvent.moodCode
        Control0..1
        BindingThe codes SHALL be taken from CDAActMood
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueEVN
        2172. ClinicalDocument.documentationOf.serviceEvent.id
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        2174. ClinicalDocument.documentationOf.serviceEvent.code
        Definition

        Drawn from concept domain ActCode

        ShortThe code should be selected from a value set established by the document-level template for a specific type of Patient Generated Document.
        Comments

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

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        2176. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
        Definition

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

        ShortBase for all types and resources
        Comments

        This serviceEvent SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:4537-14837).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
        Is Modifierfalse
        Invariantsivl-ts-center: Center cannot co-exist with low or high (center.empty() or (low.empty() and high.empty()))
        ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. (value.exists() implies value.toString().length() >= 10)
        ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component. (value.exists() implies value.toString().length() > 10)
        2178. 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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2180. 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.

        ShortEither @value or low/high should be present, but not both
        Control0..1
        TypedateTime(ts: Point in Time)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
        XML FormatIn the XML format, this property is represented as an attribute.
        2182. 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
        BindingThe codes SHALL be taken from CDASetOperator
        (required to http://hl7.org/cda/stds/core/ValueSet/CDASetOperator)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Default ValueI
        2184. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low
        Definition

        This is the low limit of the interval.

        Short**MAY** be precise to at least the second
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
        LabelLow Boundary
        Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
        ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
        2186. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2188. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.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(ts: Point in Time)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
        XML FormatIn the XML format, this property is represented as an attribute.
        2190. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Default Valuetrue
        2192. 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/cda/stds/core/StructureDefinition/TS
        LabelCentral Value
        2194. 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/cda/stds/core/StructureDefinition/PQ
        LabelWidth
        2196. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
        Definition

        This is the high limit of the interval.

        Short**MAY** be precise to at least the second
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
        LabelHigh Boundary
        Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
        ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
        2198. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2200. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.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(ts: Point in Time)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
        XML FormatIn the XML format, this property is represented as an attribute.
        2202. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Default Valuetrue
        2204. ClinicalDocument.documentationOf.serviceEvent.performer
        ShortThe performer participant represents clinicians who actually and principally carry out the serviceEvent. In a transfer of care this represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient's key healthcare care team members would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors.
        Comments

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer1
        2206. 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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2208. 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/cda/stds/core/StructureDefinition/CS
        2210. 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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        2212. ClinicalDocument.documentationOf.serviceEvent.performer.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2214. ClinicalDocument.documentationOf.serviceEvent.performer.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        2216. ClinicalDocument.documentationOf.serviceEvent.performer.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        2218. ClinicalDocument.documentationOf.serviceEvent.performer.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        2220. ClinicalDocument.documentationOf.serviceEvent.performer.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        2222. 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/cda/stds/core/StructureDefinition/II
        2224. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode
        Comments

        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:4537-14840).

        Control1..1
        BindingThe codes SHALL be taken from x_ServiceEventPerformer .
        (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19601)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        2226. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode
        ShortWhen indicating the performer was the primary care physician, implementers should indicate "PCP" as the functionCode
        Comments

        The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:4537-16818).

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        Invariantsshould-code-attr: SHOULD contain @code (code.exists())
        2228. 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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2230. 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.

        Comments

        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:4537-32889).

        Control0..1
        BindingThe codes SHALL be taken from ParticipationFunction .
        (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.10267)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode
        2232. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystem
        Definition

        Specifies the code system that defines the code.

        Control0..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System
        2234. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemName
        Definition

        The common name of the coding system.

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Name
        2236. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemVersion
        Definition

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

        Control0..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Version
        2238. 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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplay Name
        2240. 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(oid: ISO Object Identifier)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn 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 namevalueSet.
        2242. 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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn 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 namevalueSetVersion.
        2244. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.originalText
        Definition

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

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        LabelOriginal Text
        2246. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.qualifier
        Definition

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

        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
        LabelQualifier
        2248. 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/cda/stds/core/StructureDefinition/CD
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        LabelTranslation
        2250. ClinicalDocument.documentationOf.serviceEvent.performer.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.

        ShortBase for all types and resources
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
        Is Modifierfalse
        Invariantsivl-ts-center: Center cannot co-exist with low or high (center.empty() or (low.empty() and high.empty()))
        ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. (value.exists() implies value.toString().length() >= 10)
        ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component. (value.exists() implies value.toString().length() > 10)
        2252. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
        Invariantsshould-us-code: SHOULD contain code (code.exists())
        2254. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2256. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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/cda/stds/core/StructureDefinition/CS
        2258. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        2260. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2262. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        2264. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        2266. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        2268. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        2270. 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/cda/stds/core/StructureDefinition/II
        2272. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode
        Control0..1
        BindingThe codes SHALL be taken from RoleClassAssignedEntity
        (required to http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueASSIGNED
        2274. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
        ShortThe combined @root and @extension attributes record the performer's identity in a secure, trusted, and unique way.
        Comments

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

        Control1..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        2276. 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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2278. 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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        2280. 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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        2282. 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.

        Comments

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

        Control0..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Invariantsshould-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6')
        2284. 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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        2286. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
        2288. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code
        ShortIf the assignedEntity is an individual, the code SHOULD be selected from value set PersonalandLegalRelationshipRoleType value set
        Comments

        This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28718).

        Control0..1
        BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type .
        (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        2290. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
        2292. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
        2294. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
        2296. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
        2298. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcPatient
        Control0..1
        Typehttp://hl7.org/fhir/StructureDefinition/Base
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namepatient.
        2300. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcPatient.id
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
        2302. ClinicalDocument.relatedDocument
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument
        2304. ClinicalDocument.authorization
        ShortThe authorization element represents information about the patient's consent. The type of consent is conveyed in consent/code. Consents in the header have been finalized (consent/statusCode must equal Completed) and should be on file. This specification does not address how 'Privacy Consent' is represented, but does not preclude the inclusion of 'Privacy Consent'. The authorization consent is used for referring to consents that are documented elsewhere in the EHR or medical record for a health condition and/or treatment that is described in the CDA document.
        Comments

        MAY contain zero or more [0..*] authorization (CONF:4537-16792) such that it

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authorization
        2306. ClinicalDocument.authorization.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2308. ClinicalDocument.authorization.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/cda/stds/core/StructureDefinition/CS
        2310. ClinicalDocument.authorization.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        2312. ClinicalDocument.authorization.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2314. ClinicalDocument.authorization.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        2316. ClinicalDocument.authorization.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        2318. ClinicalDocument.authorization.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        2320. ClinicalDocument.authorization.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        2322. ClinicalDocument.authorization.templateId
        Definition

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        2324. ClinicalDocument.authorization.typeCode
        Control0..1
        BindingThe codes SHALL be taken from ActRelationshipAuthorizedBy
        (required to http://terminology.hl7.org/ValueSet/v3-ActRelationshipAuthorizedBy)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueAUTH
        2326. ClinicalDocument.authorization.consent
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Consent
        2328. ClinicalDocument.authorization.consent.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2330. ClinicalDocument.authorization.consent.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/cda/stds/core/StructureDefinition/CS
        2332. ClinicalDocument.authorization.consent.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        2334. ClinicalDocument.authorization.consent.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2336. ClinicalDocument.authorization.consent.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        2338. ClinicalDocument.authorization.consent.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        2340. ClinicalDocument.authorization.consent.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        2342. ClinicalDocument.authorization.consent.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        2344. ClinicalDocument.authorization.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/cda/stds/core/StructureDefinition/II
        2346. ClinicalDocument.authorization.consent.classCode
        Control0..1
        BindingThe codes SHALL be taken from CDAActClass
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueCONS
        2348. ClinicalDocument.authorization.consent.moodCode
        Control0..1
        BindingThe codes SHALL be taken from CDAActMood
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueEVN
        2350. ClinicalDocument.authorization.consent.id
        Definition

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

        ShortLogical id of this artifact
        Comments

        This consent MAY contain zero or more [0..*] id (CONF:4537-16794).


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

        Control0..*1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IIid
        Is Modifierfalse
        2352. ClinicalDocument.authorization.consent.code
        ShortThe type of consent (e.g., a consent to perform the related serviceEvent) is conveyed in consent/code.
        Comments

        This consent MAY contain zero or one [0..1] code (CONF:4537-16795).

        Control0..1
        BindingFor example codes, see v3 Code System ActCode
        (example to http://terminology.hl7.org/ValueSet/v3-ActCode)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        2354. ClinicalDocument.authorization.consent.statusCode
        Comments

        This consent SHALL contain exactly one [1..1] statusCode (CONF:4537-16797).

        Control1..1
        BindingThe codes SHALL be taken from ActStatus
        (required to http://terminology.hl7.org/ValueSet/v3-ActStatus)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
        2356. ClinicalDocument.authorization.consent.statusCode.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2358. ClinicalDocument.authorization.consent.statusCode.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.

        Comments

        This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:4537-16798).

        Control1..1
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode
        Fixed Valuecompleted
        2360. ClinicalDocument.authorization.consent.statusCode.codeSystem
        Definition

        Specifies the code system that defines the code.

        Control0..0
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System
        2362. ClinicalDocument.authorization.consent.statusCode.codeSystemName
        Definition

        The common name of the coding system.

        Control0..0
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Name
        2364. ClinicalDocument.authorization.consent.statusCode.codeSystemVersion
        Definition

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

        Control0..0
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Version
        2366. ClinicalDocument.authorization.consent.statusCode.displayName
        Definition

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

        Control0..0
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplay Name
        2368. ClinicalDocument.authorization.consent.statusCode.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(oid: ISO Object Identifier)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn 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 namevalueSet.
        2370. ClinicalDocument.authorization.consent.statusCode.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn 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 namevalueSetVersion.
        2372. ClinicalDocument.authorization.consent.statusCode.originalText
        Definition

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

        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        LabelOriginal Text
        2374. ClinicalDocument.authorization.consent.statusCode.qualifier
        Definition

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

        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
        LabelQualifier
        2376. ClinicalDocument.authorization.consent.statusCode.translation
        Definition

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

        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        LabelTranslation
        2378. ClinicalDocument.componentOf
        ShortThe encompassing encounter represents the setting of the clinical encounter during which the document act(s) or ServiceEvent(s) occurred. In order to represent providers associated with a specific encounter, they are recorded within the encompassingEncounter as participants. In a CCD, the encompassingEncounter may be used when documenting a specific encounter and its participants. All relevant encounters in a CCD may be listed in the encounters section.
        Comments

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

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ComponentOf
        2380. 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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2382. 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/cda/stds/core/StructureDefinition/CS
        2384. 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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        2386. ClinicalDocument.componentOf.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2388. ClinicalDocument.componentOf.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        2390. ClinicalDocument.componentOf.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        2392. ClinicalDocument.componentOf.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        2394. ClinicalDocument.componentOf.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        2396. 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/cda/stds/core/StructureDefinition/II
        2398. ClinicalDocument.componentOf.typeCode
        Control0..1
        BindingThe codes SHALL be taken from ActRelationshipHasComponent
        (required to http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueCOMP
        2400. ClinicalDocument.componentOf.encompassingEncounter
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EncompassingEncounter
        Invariantsshould-responsibleParty: SHOULD contain responsibleParty (responsibleParty.exists())
        2402. ClinicalDocument.componentOf.encompassingEncounter.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2404. ClinicalDocument.componentOf.encompassingEncounter.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/cda/stds/core/StructureDefinition/CS
        2406. ClinicalDocument.componentOf.encompassingEncounter.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        2408. ClinicalDocument.componentOf.encompassingEncounter.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2410. ClinicalDocument.componentOf.encompassingEncounter.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        2412. ClinicalDocument.componentOf.encompassingEncounter.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        2414. ClinicalDocument.componentOf.encompassingEncounter.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        2416. ClinicalDocument.componentOf.encompassingEncounter.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        2418. 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/cda/stds/core/StructureDefinition/II
        2420. ClinicalDocument.componentOf.encompassingEncounter.classCode
        Control0..1
        BindingThe codes SHALL be taken from CDAActClass
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueENC
        2422. ClinicalDocument.componentOf.encompassingEncounter.moodCode
        Control0..1
        BindingThe codes SHALL be taken from CDAActMood
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueEVN
        2424. ClinicalDocument.componentOf.encompassingEncounter.id
        Comments

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

        Control1..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        2426. ClinicalDocument.componentOf.encompassingEncounter.code
        Comments

        This encompassingEncounter MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Act Encounter Codes urn:oid:2.16.840.1.113762.1.4.1240.5 (CONF:1198-30873).

        Control0..1
        BindingThe codes SHOULD be taken from Act Encounter Codes .
        (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1240.5)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        2428. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime
        Definition

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

        ShortBase for all types and resources
        Comments

        This encompassingEncounter SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:4537-9958).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
        Is Modifierfalse
        Invariantsivl-ts-center: Center cannot co-exist with low or high (center.empty() or (low.empty() and high.empty()))
        ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. (value.exists() implies value.toString().length() >= 10)
        ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component. (value.exists() implies value.toString().length() > 10)
        2430. ClinicalDocument.componentOf.encompassingEncounter.sdtcAdmissionReferralSourceCode
        Definition

        This element is a coded concept that represents the type of referral. Its RIM source class is PatientEncounter.

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameadmissionReferralSourceCode.
        2432. ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode
        Control0..1
        BindingFor example codes, see USEncounterDischargeDisposition
        (example to http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        2434. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty
        Definition

        The responsibleParty participant represents the participant having primary legal responsibility for the encounter. This differs from the legalAuthenticator participant in that the legalAuthenticator may or may not be the responsible party, and is serving a medical records function by signing off on the document, moving it into a completed state.

        Comments

        This encompassingEncounter SHOULD contain zero or one [0..1] responsibleParty (CONF:1198-8391).

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
        2436. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2438. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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/cda/stds/core/StructureDefinition/CS
        2440. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        2442. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2444. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        2446. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        2448. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        2450. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        2452. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.templateId
        Definition

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        2454. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCode
        Control0..1
        BindingThe codes SHALL be taken from CDAParticipationType
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueRESP
        2456. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity
        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
        Invariants1198-32905: This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). (assignedPerson.exists() or representedOrganization.exists())
        2458. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant
        2460. ClinicalDocument.componentOf.encompassingEncounter.location
        Definition

        The location participant (location class) relates a healthcare facility (HealthCareFacility class) to the encounter to indicate where the encounter took place. The entity playing the role of HealthCareFacility is a place (Place class). The entity scoping the HealthCareFacility role is an organization (Organization class).

        The setting of an encounter (e.g. cardiology clinic, primary care clinic, rehabilitation hospital, skilled nursing facility) can be expressed in HealthCareFacility.code. Note that setting and physical location are not the same. There is a many-to-many relationship between setting and the physical location where care is delivered. Thus, a particular room can provide the location for cardiology clinic one day, and for primary care clinic another day; and cardiology clinic today might be held in one physical location, but in another physical location tomorrow.

        When the location is an organization, this is indicated by the presence of a scoping Organization, without a playing Place.

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
        2462. ClinicalDocument.componentOf.encompassingEncounter.location.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2464. ClinicalDocument.componentOf.encompassingEncounter.location.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/cda/stds/core/StructureDefinition/CS
        2466. ClinicalDocument.componentOf.encompassingEncounter.location.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/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        2468. ClinicalDocument.componentOf.encompassingEncounter.location.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        2470. ClinicalDocument.componentOf.encompassingEncounter.location.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        2472. ClinicalDocument.componentOf.encompassingEncounter.location.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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        2474. ClinicalDocument.componentOf.encompassingEncounter.location.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        2476. ClinicalDocument.componentOf.encompassingEncounter.location.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        2478. ClinicalDocument.componentOf.encompassingEncounter.location.templateId
        Definition

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        2480. ClinicalDocument.componentOf.encompassingEncounter.location.typeCode
        Control0..1
        BindingThe codes SHALL be taken from ParticipationTargetLocation
        (required to http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueLOC
        2482. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility
        2484. ClinicalDocument.component
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Component

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

        0. ClinicalDocument
        Definition

        Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

        ShortBase for all types and resources
        Control1..1
        Is Modifierfalse
        Logical ContainerClinicalDocument (CDA Class)
        ValidationInstance of this type are validated by templateId
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
        Invariants4537-6380: If setId is present versionNumber **SHALL** be present (CONF:4537-6380). (setId.exists() implies versionNumber.exists())
        4537-6387: If versionNumber is present setId **SHALL** be present (CONF:4537-6387). (versionNumber.exists() implies setId.exists())
        should-legalAuthenticator: SHOULD contain legalAuthenticator (legalAuthenticator.exists())
        should-relatedParticipant: Documents SHOULD contain a RelatedPerson participant (participant.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/RelatedPersonRelationshipAndNameParticipant').exists())
        2. ClinicalDocument.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        4. ClinicalDocument.classCode
        Control0..1
        BindingFor example codes, see CDAActClass
        (example to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueDOCCLIN
        6. ClinicalDocument.moodCode
        Control0..1
        BindingThe codes SHALL be taken from CDAActMood
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueEVN
        8. 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

        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
        10. ClinicalDocument.realmCode.nullFlavor
        Definition

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

        Control0..1
        BindingThe codes SHALL be taken from CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        12. ClinicalDocument.realmCode.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
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode
        Pattern ValueUS
        14. ClinicalDocument.realmCode.codeSystem
        Definition

        Specifies the code system that defines the code.

        Control0..0
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System
        16. ClinicalDocument.realmCode.codeSystemName
        Definition

        The common name of the coding system.

        Control0..0
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Name
        18. ClinicalDocument.realmCode.codeSystemVersion
        Definition

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

        Control0..0
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode System Version
        20. ClinicalDocument.realmCode.displayName
        Definition

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

        Control0..0
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplay Name
        22. ClinicalDocument.realmCode.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(oid: ISO Object Identifier)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn 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 namevalueSet.
        24. ClinicalDocument.realmCode.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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn 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 namevalueSetVersion.
        26. ClinicalDocument.realmCode.originalText
        Definition

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

        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        LabelOriginal Text
        28. ClinicalDocument.realmCode.qualifier
        Definition

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

        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
        LabelQualifier
        30. ClinicalDocument.realmCode.translation
        Definition

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

        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        LabelTranslation
        32. ClinicalDocument.typeId
        Definition

        ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = "2.16.840.1.113883.1.3" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = "POCD_HD000040" (which is the unique identifier for the CDA, Release Two Hierarchical Description).

        Comments

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

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        34. 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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExceptional Value Detail
        36. 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(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelAssigning Authority Name
        38. 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(bl: Boolean)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelDisplayable
        40. ClinicalDocument.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Comments

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

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        42. ClinicalDocument.typeId.extension
        Definition

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

        Comments

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

        Control1..1
        Typestring(st: Character String)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelExtension
        Fixed ValuePOCD_HD000040
        44. 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

        Control2..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        SlicingThis element introduces a set of slices on ClinicalDocument.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ root
        • value @ extension
        • 46. ClinicalDocument.templateId:us-realm
          Slice Nameus-realm
          Definition

          When valued in an instance, this attribute 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/cda/stds/core/StructureDefinition/II
          48. ClinicalDocument.templateId:us-realm.nullFlavor
          Definition

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

          Control0..1
          BindingThe codes SHALL be taken from CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          50. ClinicalDocument.templateId:us-realm.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(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelAssigning Authority Name
          52. ClinicalDocument.templateId:us-realm.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(bl: Boolean)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelDisplayable
          54. ClinicalDocument.templateId:us-realm.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(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelRoot
          Pattern Value2.16.840.1.113883.10.20.22.1.1
          56. ClinicalDocument.templateId:us-realm.extension
          Definition

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

          Control1..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExtension
          Pattern Value2024-05-01
          58. ClinicalDocument.templateId:us-patient-gen-doc
          Slice Nameus-patient-gen-doc
          Definition

          When valued in an instance, this attribute 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/cda/stds/core/StructureDefinition/II
          60. ClinicalDocument.templateId:us-patient-gen-doc.nullFlavor
          Definition

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

          Control0..1
          BindingThe codes SHALL be taken from CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          62. ClinicalDocument.templateId:us-patient-gen-doc.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(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelAssigning Authority Name
          64. ClinicalDocument.templateId:us-patient-gen-doc.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(bl: Boolean)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelDisplayable
          66. ClinicalDocument.templateId:us-patient-gen-doc.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(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelRoot
          Pattern Value2.16.840.1.113883.10.20.29.1
          68. ClinicalDocument.templateId:us-patient-gen-doc.extension
          Definition

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

          Control1..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExtension
          Pattern Value2024-05-01
          70. ClinicalDocument.id
          Short**SHALL** be a globally unique identifier for the document (CONF:4537-9991).
          Comments

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

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
          72. ClinicalDocument.sdtcCategory
          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
          XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namecategory.
          74. ClinicalDocument.code
          Short**SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992).
          Comments

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

          Control1..1
          BindingFor example codes, see FHIRDocumentTypeCodes
          (example to http://hl7.org/fhir/ValueSet/doc-typecodes)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          76. 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..0
          BindingThe codes SHALL be taken from CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          78. 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
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelCode
          80. ClinicalDocument.code.codeSystem
          Definition

          Specifies the code system that defines the code.

          Control1..1
          Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelCode System
          Pattern Value2.16.840.1.113883.6.1
          82. ClinicalDocument.code.codeSystemName
          Definition

          The common name of the coding system.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelCode System Name
          84. ClinicalDocument.code.codeSystemVersion
          Definition

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

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelCode System Version
          86. 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(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelDisplay Name
          88. 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(oid: ISO Object Identifier)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn 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 namevalueSet.
          90. 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(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn 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 namevalueSetVersion.
          92. ClinicalDocument.code.originalText
          Definition

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

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
          LabelOriginal Text
          94. ClinicalDocument.code.qualifier
          Definition

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

          Control0..0
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
          LabelQualifier
          96. ClinicalDocument.code.translation
          Definition

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

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
          XML FormatThe type of this property is determined using the xsi:typeattribute.
          LabelTranslation
          98. ClinicalDocument.title
          ShortThe title can either be a locally defined name or the displayName corresponding to clinicalDocument/code
          Comments

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

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
          100. ClinicalDocument.sdtcStatusCode
          Definition

          The statusCode extension attribute allows the implementer to identify a ClinicalDocument that is in other than the completed state. It was created to support the Structured Form Definition IG to identify that the document itself is an unfinished product currently being completed for a patient.

          Control0..1
          BindingThe codes SHALL be taken from ActStatus
          (required to http://terminology.hl7.org/ValueSet/v3-ActStatus)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
          XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namestatusCode.
          102. 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.

          ShortBase for all types and resources
          Comments

          SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5256).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
          Is Modifierfalse
          Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
          ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
          104. ClinicalDocument.confidentialityCode
          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          106. ClinicalDocument.confidentialityCode.nullFlavor
          Definition

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

          Control0..0
          BindingThe codes SHALL be taken from CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          108. ClinicalDocument.confidentialityCode.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 HL7 BasicConfidentialityKind .
          (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.16926)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelCode
          110. ClinicalDocument.confidentialityCode.codeSystem
          Definition

          Specifies the code system that defines the code.

          Control0..1
          Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelCode System
          112. ClinicalDocument.confidentialityCode.codeSystemName
          Definition

          The common name of the coding system.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelCode System Name
          114. ClinicalDocument.confidentialityCode.codeSystemVersion
          Definition

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

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelCode System Version
          116. ClinicalDocument.confidentialityCode.displayName
          Definition

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

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelDisplay Name
          118. ClinicalDocument.confidentialityCode.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(oid: ISO Object Identifier)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn 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 namevalueSet.
          120. ClinicalDocument.confidentialityCode.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(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn 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 namevalueSetVersion.
          122. ClinicalDocument.confidentialityCode.originalText
          Definition

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

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
          LabelOriginal Text
          124. ClinicalDocument.confidentialityCode.qualifier
          Definition

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

          Control0..0
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
          LabelQualifier
          126. ClinicalDocument.confidentialityCode.translation
          Definition

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

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
          XML FormatThe type of this property is determined using the xsi:typeattribute.
          LabelTranslation
          128. ClinicalDocument.languageCode
          Comments

          SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet AllLanguages https://www.hl7.org/fhir/valueset-all-languages.html (OID 2.16.840.1.113883.4.642.3.21) DYNAMIC.

          Control1..1
          BindingThe codes SHALL be taken from AllLanguages
          (required to http://hl7.org/fhir/ValueSet/all-languages)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
          130. ClinicalDocument.setId
          Comments

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

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
          132. ClinicalDocument.versionNumber
          Comments

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

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
          134. ClinicalDocument.copyTime
          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
          136. ClinicalDocument.recordTarget
          ShortThe recordTarget records the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element. If the document receiver is interested in setting up a translator for the encounter with the patient, the receiver of the document will have to infer the need for a translator, based upon the language skills identified for the patient, the patient's language of preference and the predominant language used by the organization receiving the CDA. HL7 Vocabulary simply describes guardian as a relationship to a ward. This need not be a formal legal relationship. When a guardian relationship exists for the patient, it can be represented, regardless of who is present at the time the document is generated. This need not be a formal legal relationship. A child's parent can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of "mother" for the child's mom or "father" for the child's dad. An elderly person's child can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of "daughter" or "son", or if a legal relationship existed, the relationship of "legal guardian" could be encoded.
          Comments

          SHALL contain exactly one [1..1] recordTarget (CONF:1198-28460).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
          138. 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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          140. 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/cda/stds/core/StructureDefinition/CS
          142. 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/cda/stds/core/StructureDefinition/II
          InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
          144. ClinicalDocument.recordTarget.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          146. ClinicalDocument.recordTarget.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(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelAssigning Authority Name
          148. ClinicalDocument.recordTarget.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(bl: Boolean)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelDisplayable
          150. ClinicalDocument.recordTarget.typeId.root
          Definition

          Identifies the type as an HL7 Registered model

          Control1..1
          Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelRoot
          Fixed Value2.16.840.1.113883.1.3
          152. ClinicalDocument.recordTarget.typeId.extension
          Definition

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

          Control1..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExtension
          154. 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/cda/stds/core/StructureDefinition/II
          156. ClinicalDocument.recordTarget.typeCode
          Control0..1
          BindingThe codes SHALL be taken from CDAParticipationType
          (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueRCT
          158. ClinicalDocument.recordTarget.contextControlCode
          Control0..1
          BindingThe codes SHALL be taken from CDAContextControl
          (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueOP
          160. ClinicalDocument.recordTarget.patientRole
          Comments

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

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/PatientRole
          162. ClinicalDocument.recordTarget.patientRole.nullFlavor
          Definition

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

          Control0..1
          BindingThe codes SHALL be taken from CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          164. ClinicalDocument.recordTarget.patientRole.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/cda/stds/core/StructureDefinition/CS
          166. ClinicalDocument.recordTarget.patientRole.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/cda/stds/core/StructureDefinition/II
          InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
          168. ClinicalDocument.recordTarget.patientRole.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          170. ClinicalDocument.recordTarget.patientRole.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(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelAssigning Authority Name
          172. ClinicalDocument.recordTarget.patientRole.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(bl: Boolean)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelDisplayable
          174. ClinicalDocument.recordTarget.patientRole.typeId.root
          Definition

          Identifies the type as an HL7 Registered model

          Control1..1
          Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelRoot
          Fixed Value2.16.840.1.113883.1.3
          176. ClinicalDocument.recordTarget.patientRole.typeId.extension
          Definition

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

          Control1..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExtension
          178. 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/cda/stds/core/StructureDefinition/II
          180. ClinicalDocument.recordTarget.patientRole.classCode
          Control0..1
          BindingThe codes SHALL be taken from RoleClassRelationshipFormal
          (required to http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValuePAT
          182. ClinicalDocument.recordTarget.patientRole.id
          Comments

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

          Control1..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
          184. ClinicalDocument.recordTarget.patientRole.sdtcIdentifiedBy
          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
          XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
          186. 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.

          Short𝗨𝗦𝗖𝗗𝗜: Address
          Comments

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

          Control1..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
          Is Modifierfalse
          Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
          shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
          should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
          should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
          81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
          81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
          81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
          shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
          188. ClinicalDocument.recordTarget.patientRole.telecom
          Short𝗨𝗦𝗖𝗗𝗜: Phone Number / Email
          Control1..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
          Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
          190. 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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          192. ClinicalDocument.recordTarget.patientRole.telecom.value
          Control0..1
          Typeurl(url: Universal Resource Locator)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          194. 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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
          Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
          XML FormatThe type of this property is determined using the xsi:typeattribute.
          LabelUseable Period
          196. 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.

          Comments

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

          Control0..1
          BindingThe codes SHALL be taken from Telecom Use (US Realm Header) .
          (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelUse Code
          198. ClinicalDocument.recordTarget.patientRole.patient
          Comments

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

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Patient
          Invariants4537-32993: If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present with either a @value or @nullFlavor=UNK (CONF:4537-32993). (sdtcDeceasedInd.exists(value='true') implies sdtcDeceasedTime.exists())
          4537-21000: If sdtc:deceasedTime/@value is present, then sdtc:deceasedInd SHALL be present with value=true (sdtcDeceasedTime.value.exists() implies sdtcDeceasedInd.exists(value='true'))
          should-maritalStatusCode: SHOULD contain maritalStatusCode (maritalStatusCode.exists())
          should-us-languageCommunication: SHOULD contain languageCommunication (languageCommunication.exists())
          should-languageCommunication: SHOULD contain languageCommunication (languageCommunication.exists())
          200. ClinicalDocument.recordTarget.patientRole.patient.nullFlavor
          Definition

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

          Control0..1
          BindingThe codes SHALL be taken from CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          202. ClinicalDocument.recordTarget.patientRole.patient.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/cda/stds/core/StructureDefinition/CS
          204. ClinicalDocument.recordTarget.patientRole.patient.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/cda/stds/core/StructureDefinition/II
          InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
          206. ClinicalDocument.recordTarget.patientRole.patient.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          208. ClinicalDocument.recordTarget.patientRole.patient.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(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelAssigning Authority Name
          210. ClinicalDocument.recordTarget.patientRole.patient.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(bl: Boolean)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelDisplayable
          212. ClinicalDocument.recordTarget.patientRole.patient.typeId.root
          Definition

          Identifies the type as an HL7 Registered model

          Control1..1
          Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelRoot
          Fixed Value2.16.840.1.113883.1.3
          214. ClinicalDocument.recordTarget.patientRole.patient.typeId.extension
          Definition

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

          Control1..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExtension
          216. 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/cda/stds/core/StructureDefinition/II
          218. ClinicalDocument.recordTarget.patientRole.patient.classCode
          Control0..1
          BindingThe codes SHALL be taken from EntityClassLivingSubject
          (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValuePSN
          220. ClinicalDocument.recordTarget.patientRole.patient.determinerCode
          Control0..1
          BindingThe codes SHALL be taken from EntityDeterminer
          (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueINSTANCE
          222. ClinicalDocument.recordTarget.patientRole.patient.id
          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
          224. 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).

          ShortBase for all types and resources
          Comments

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

          Control1..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Patient Name (PTN.US.FIELDED))
          Is Modifierfalse
          Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
          shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). (nullFlavor.exists() or item.family.count() = 1)
          shall-given: SHALL contain at least one [1..*] given (CONF:81-7157). (nullFlavor.exists() or item.given.exists())
          shall-max-suffix: There may be at most one suffix ((item.suffix.empty() or item.suffix.count() = 1))
          81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). (item.xmlText.empty())
          226. ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc
          Definition

          The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
          XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
          228. ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode
          Comments

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

          Control1..1
          BindingThe codes SHALL be taken from Administrative Gender (HL7 V3) .
          (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.1)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          230. ClinicalDocument.recordTarget.patientRole.patient.birthTime
          Short𝗨𝗦𝗖𝗗𝗜: Date of Birth - **MAY** be precise to the minute (CONF:4537-32418) (For cases where information about newborn's time of birth needs to be captured)
          Comments

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

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
          Invariantsts-shall-year: **SHALL** be precise to at least the year (nullFlavor.exists() or value.toString().length() >= 4)
          ts-should-day: **SHOULD** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
          232. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd
          Shortsdtc:deceasedInd
          Comments

          This patient MAY contain zero or one [0..1] sdtc:deceasedInd (CONF:4537-32990).

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
          XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedInd.
          234. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime
          Short𝗨𝗦𝗖𝗗𝗜: Date of Death
          Comments

          This patient MAY contain zero or one [0..1] sdtc:deceasedTime (CONF:4537-32988).

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
          XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedTime.
          Invariantsshould-value-att: SHOULD contain @value (value.exists())
          ts-shall-year: **SHALL** be precise to at least the year (nullFlavor.exists() or value.toString().length() >= 4)
          ts-should-day: **SHOULD** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
          236. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd
          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
          XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthInd.
          238. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber
          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT-POS
          XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthOrderNumber.
          240. ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode
          Comments

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

          Control0..1
          BindingThe codes SHALL be taken from Marital Status .
          (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12212)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          242. ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode
          Comments

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

          Control0..1
          BindingThe codes SHALL be taken from Religious Affiliation .
          (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19185)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          244. ClinicalDocument.recordTarget.patientRole.patient.raceCode
          Short𝗨𝗦𝗖𝗗𝗜: Race
          Comments

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

          Control1..1
          BindingThe codes SHALL be taken from Race Category Excluding Nulls .
          (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.2074.1.1.3)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          246. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode
          Short𝗨𝗦𝗖𝗗𝗜: Race - The sdtc:raceCode is only used to record additional values when the patient has indicated multiple races or additional race detail beyond the five categories required for Meaningful Use Stage 2. The prefix sdtc: SHALL be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the additional raceCode elements.
          Comments

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

          Control0..*
          BindingThe codes SHALL be taken from Race Value Set .
          (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameraceCode.
          248. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode
          Short𝗨𝗦𝗖𝗗𝗜: Ethnicity
          Comments

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

          Control1..1
          BindingThe codes SHALL be taken from Ethnicity .
          (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.837)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          250. ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode
          Short𝗨𝗦𝗖𝗗𝗜: Ethnicity
          Comments

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

          Control0..*
          BindingThe codes SHALL be taken from Detailed Ethnicity .
          (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.877)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameethnicGroupCode.
          252. ClinicalDocument.recordTarget.patientRole.patient.guardian
          Comments

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

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Guardian
          Invariantsshould-us-code: SHOULD contain code (code.exists())
          should-us-addr: SHOULD contain addr (addr.exists())
          should-us-telecom: SHOULD contain telecom (telecom.exists())
          should-id: SHOULD contain id (id.exists())
          should-code: SHOULD contain code (code.exists())
          254. ClinicalDocument.recordTarget.patientRole.patient.guardian.nullFlavor
          Definition

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

          Control0..1
          BindingThe codes SHALL be taken from CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          256. ClinicalDocument.recordTarget.patientRole.patient.guardian.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/cda/stds/core/StructureDefinition/CS
          258. ClinicalDocument.recordTarget.patientRole.patient.guardian.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/cda/stds/core/StructureDefinition/II
          InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
          260. ClinicalDocument.recordTarget.patientRole.patient.guardian.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          262. ClinicalDocument.recordTarget.patientRole.patient.guardian.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(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelAssigning Authority Name
          264. ClinicalDocument.recordTarget.patientRole.patient.guardian.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(bl: Boolean)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelDisplayable
          266. ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.root
          Definition

          Identifies the type as an HL7 Registered model

          Control1..1
          Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelRoot
          Fixed Value2.16.840.1.113883.1.3
          268. ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.extension
          Definition

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

          Control1..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExtension
          270. 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/cda/stds/core/StructureDefinition/II
          272. ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode
          Control0..1
          BindingThe codes SHALL be taken from RoleClassAgent
          (required to http://terminology.hl7.org/ValueSet/v3-RoleClassAgent)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueGUARD
          274. ClinicalDocument.recordTarget.patientRole.patient.guardian.id
          Comments

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

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
          276. ClinicalDocument.recordTarget.patientRole.patient.guardian.sdtcIdentifiedBy
          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
          XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
          278. ClinicalDocument.recordTarget.patientRole.patient.guardian.code
          Comments

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

          Control0..1
          BindingThe codes SHALL be taken from Personal And Legal Relationship Role Type .
          (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          280. 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.

          ShortBase for all types and resources
          Comments

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

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
          Is Modifierfalse
          Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
          shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
          should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
          should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
          81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
          81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
          81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
          shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
          282. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom
          Comments

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

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
          Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
          284. 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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          286. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value
          Control0..1
          Typeurl(url: Universal Resource Locator)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          288. 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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
          Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
          XML FormatThe type of this property is determined using the xsi:typeattribute.
          LabelUseable Period
          290. 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.

          Comments

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

          Control0..1
          BindingThe codes SHALL be taken from Telecom Use (US Realm Header) .
          (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelUse Code
          292. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson
          Comments

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

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
          294. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.nullFlavor
          Definition

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

          Control0..1
          BindingThe codes SHALL be taken from CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          296. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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/cda/stds/core/StructureDefinition/CS
          298. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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/cda/stds/core/StructureDefinition/II
          InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
          300. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          302. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelAssigning Authority Name
          304. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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(bl: Boolean)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelDisplayable
          306. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.root
          Definition

          Identifies the type as an HL7 Registered model

          Control1..1
          Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelRoot
          Fixed Value2.16.840.1.113883.1.3
          308. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.extension
          Definition

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

          Control1..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExtension
          310. 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/cda/stds/core/StructureDefinition/II
          312. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode
          Control0..1
          BindingThe codes SHALL be taken from EntityClassLivingSubject
          (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValuePSN
          314. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode
          Control0..1
          BindingThe codes SHALL be taken from EntityDeterminer
          (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueINSTANCE
          316. 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).

          ShortBase for all types and resources
          Comments

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

          Control1..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
          Is Modifierfalse
          Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
          81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
          81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
          318. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcDesc
          Definition

          The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
          XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
          320. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship
          Definition

          Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
          XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
          322. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.nullFlavor
          Definition

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

          Control0..1
          BindingThe codes SHALL be taken from CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          324. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/CS
          326. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/II
          InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
          328. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          330. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelAssigning Authority Name
          332. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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(bl: Boolean)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelDisplayable
          334. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.root
          Definition

          Identifies the type as an HL7 Registered model

          Control1..1
          Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelRoot
          Fixed Value2.16.840.1.113883.1.3
          336. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.extension
          Definition

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

          Control1..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExtension
          338. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.templateId
          Definition

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

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
          340. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.classCode
          Control1..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValuePRS
          342. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.determinerCode
          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueINSTANCE
          344. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.code
          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
          346. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization
          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
          348. ClinicalDocument.recordTarget.patientRole.patient.birthplace
          Comments

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

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Birthplace
          350. ClinicalDocument.recordTarget.patientRole.patient.birthplace.nullFlavor
          Definition

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

          Control0..1
          BindingThe codes SHALL be taken from CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          352. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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/cda/stds/core/StructureDefinition/CS
          354. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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/cda/stds/core/StructureDefinition/II
          InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
          356. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          358. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelAssigning Authority Name
          360. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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(bl: Boolean)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelDisplayable
          362. ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.root
          Definition

          Identifies the type as an HL7 Registered model

          Control1..1
          Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelRoot
          Fixed Value2.16.840.1.113883.1.3
          364. ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.extension
          Definition

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

          Control1..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExtension
          366. 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/cda/stds/core/StructureDefinition/II
          368. ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode
          Control0..1
          BindingThe codes SHALL be taken from RoleClassPassive
          (required to http://terminology.hl7.org/ValueSet/v3-RoleClassPassive)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueBIRTHPL
          370. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place
          Comments

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

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Place
          372. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.nullFlavor
          Definition

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

          Control0..1
          BindingThe codes SHALL be taken from CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          374. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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/cda/stds/core/StructureDefinition/CS
          376. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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/cda/stds/core/StructureDefinition/II
          InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
          378. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          380. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelAssigning Authority Name
          382. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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(bl: Boolean)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelDisplayable
          384. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.root
          Definition

          Identifies the type as an HL7 Registered model

          Control1..1
          Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelRoot
          Fixed Value2.16.840.1.113883.1.3
          386. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.extension
          Definition

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

          Control1..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExtension
          388. 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/cda/stds/core/StructureDefinition/II
          390. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode
          Control0..1
          BindingThe codes SHALL be taken from EntityClassPlace
          (required to http://terminology.hl7.org/ValueSet/v3-EntityClassPlace)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValuePLC
          392. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode
          Control0..1
          BindingThe codes SHALL be taken from EntityDeterminer
          (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueINSTANCE
          394. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name
          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/EN
          396. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr
          Comments

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

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
          Invariants4537-5402: If country is US, this addr **SHALL** contain exactly one [1..1] state, which **SHALL** be selected from ValueSet US Core USPS State *DYNAMIC* (CONF:4537-5402). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
          4537-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:4537-5403). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.empty() or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
          should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
          398. 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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          400. 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(bl: Boolean)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelIs Not Ordered
          402. 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..*
          BindingThe codes SHALL be taken from CDAPostalAddressUse
          (required to http://hl7.org/cda/stds/core/ValueSet/CDAPostalAddressUse)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelUse Code
          404. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item
          Definition

          A series of items that constitute the address.

          Control0..*
          Typehttp://hl7.org/fhir/StructureDefinition/Base
          Choice GroupThis is a repeating choice group that does not appear directly in the instance
          InvariantsAD-1: Can only have only one of the possible item elements in each choice ((delimiter | country | state | county | city | postalCode | streetAddressLine | houseNumber | houseNumberNumeric | direction | streetName | streetNameBase | streetNameType | additionalLocator | unitID | unitType | careOf | censusTract | deliveryAddressLine | deliveryInstallationType | deliveryInstallationArea | deliveryInstallationQualifier | deliveryMode | deliveryModeIdentifier | buildingNumberSuffix | postBox | precinct | xmlText).count() = 1)
          406. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter
          Definition

          Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break.

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          408. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          410. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          412. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          414. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          416. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          418. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueDEL
          420. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country
          Definition

          Country

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          422. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          424. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          426. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          428. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          430. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          432. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueCNT
          434. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state
          Definition

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

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          436. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          438. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          440. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          442. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          444. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          446. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueSTA
          448. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          450. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          452. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          454. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          456. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          458. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          460. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueCPA
          462. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city
          Definition

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

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          464. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          466. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          468. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          470. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          472. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          474. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueCTY
          476. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode
          Definition

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

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          478. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          480. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          482. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          484. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          486. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          488. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueZIP
          490. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine
          Definition

          Street address line

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          492. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          494. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          496. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          498. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          500. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          502. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueSAL
          504. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          506. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          508. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          510. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          512. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          514. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          516. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueBNR
          518. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric
          Definition

          The numeric portion of a building number

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          520. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          522. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          524. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          526. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          528. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          530. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueBNN
          532. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction
          Definition

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

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          534. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          536. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          538. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          540. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          542. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          544. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueDIR
          546. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName
          Definition

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

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          548. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          550. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          552. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          554. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          556. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          558. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueSTR
          560. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase
          Definition

          The base name of a roadway or artery recognized by a municipality (excluding street type and direction)

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          562. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          564. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          566. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          568. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          570. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          572. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueSTB
          574. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType
          Definition

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

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          576. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          578. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          580. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          582. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          584. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          586. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueSTTYP
          588. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          590. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          592. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          594. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          596. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          598. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          600. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueADL
          602. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID
          Definition

          The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          604. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          606. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          608. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          610. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          612. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          614. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueUNID
          616. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType
          Definition

          Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          618. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          620. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          622. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          624. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          626. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          628. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueUNIT
          630. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          632. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          634. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          636. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          638. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          640. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          642. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueCAR
          644. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract
          Definition

          A geographic sub-unit delineated for demographic purposes.

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          646. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          648. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          650. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          652. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          654. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          656. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueCEN
          658. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          660. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          662. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          664. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          666. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          668. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          670. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueDAL
          672. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          674. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          676. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          678. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          680. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          682. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          684. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueDINST
          686. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          688. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          690. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          692. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          694. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          696. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          698. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueDINSTA
          700. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier
          Definition

          A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'.

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          702. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          704. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          706. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          708. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          710. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          712. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueDINSTQ
          714. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode
          Definition

          Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc.

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          716. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          718. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          720. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          722. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          724. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          726. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueDMOD
          728. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          730. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          732. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          734. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          736. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          738. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          740. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueDMODID
          742. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix
          Definition

          Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          744. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          746. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          748. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          750. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          752. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          754. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueBNS
          756. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox
          Definition

          A numbered box located in a post station.

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          758. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          760. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          762. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          764. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          766. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          768. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValuePOB
          770. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct
          Definition

          A subsection of a municipality

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
          Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
          772. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          774. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.representation
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueTXT
          776. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.mediaType
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelMedia Type
          Fixed Valuetext/plain
          778. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.language
          Definition

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

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelLanguage
          780. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          782. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.partType
          Definition

          Specifies the type of the address part

          Control0..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValuePRE
          784. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.xmlText
          ShortAllows for mixed text content
          Comments

          This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as unadorned text.
          786. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.useablePeriod
          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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
          Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
          XML FormatThe type of this property is determined using the xsi:typeattribute.
          LabelUseable Period
          788. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication
          Short𝗨𝗦𝗖𝗗𝗜: Preferred Language
          Comments

          This patient SHOULD contain zero or more [0..*] languageCommunication which SHALL be selected from ValueSet AllLanguages https://www.hl7.org/fhir/valueset-all-languages.html (OID 2.16.840.1.113883.4.642.3.21) DYNAMIC (CONF:XXX).

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication
          Invariantsshould-proficiencyLevelCode: SHOULD contain proficiencyLevelCode (proficiencyLevelCode.exists())
          should-preferenceInd: SHOULD contain preferenceInd (preferenceInd.exists())
          790. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.nullFlavor
          Definition

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

          Control0..1
          BindingThe codes SHALL be taken from CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          792. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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/cda/stds/core/StructureDefinition/CS
          794. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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/cda/stds/core/StructureDefinition/II
          InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
          796. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          798. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelAssigning Authority Name
          800. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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(bl: Boolean)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelDisplayable
          802. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.root
          Definition

          Identifies the type as an HL7 Registered model

          Control1..1
          Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelRoot
          Fixed Value2.16.840.1.113883.1.3
          804. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.extension
          Definition

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

          Control1..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExtension
          806. 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/cda/stds/core/StructureDefinition/II
          808. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode
          Control1..1
          BindingThe codes SHALL be taken from AllLanguages
          (required to http://hl7.org/fhir/ValueSet/all-languages)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
          810. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCode
          Comments

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

          Control0..1
          BindingThe codes SHALL be taken from LanguageAbilityMode .
          (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12249)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          812. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode
          Comments

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

          Control0..1
          BindingThe codes SHALL be taken from LanguageAbilityProficiency .
          (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12199)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          814. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd
          ShortIndicates a preference for information about care delivery and treatments be communicated (or translated if needed) into this language. If more than one languageCommunication is present, only one languageCommunication element SHALL have a preferenceInd with a value of 1.
          Comments

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

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
          816. ClinicalDocument.recordTarget.patientRole.providerOrganization
          ShortIf present, this organization represents the provider organization where the person is claiming to be a patient.
          Comments

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

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
          LabelIf present, this organization represents the provider organization where the person is claiming to be a patient.
          818. ClinicalDocument.recordTarget.patientRole.providerOrganization.nullFlavor
          Definition

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

          Control0..1
          BindingThe codes SHALL be taken from CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          820. ClinicalDocument.recordTarget.patientRole.providerOrganization.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/cda/stds/core/StructureDefinition/CS
          822. ClinicalDocument.recordTarget.patientRole.providerOrganization.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/cda/stds/core/StructureDefinition/II
          InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
          824. ClinicalDocument.recordTarget.patientRole.providerOrganization.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          826. ClinicalDocument.recordTarget.patientRole.providerOrganization.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(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelAssigning Authority Name
          828. ClinicalDocument.recordTarget.patientRole.providerOrganization.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(bl: Boolean)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelDisplayable
          830. ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.root
          Definition

          Identifies the type as an HL7 Registered model

          Control1..1
          Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelRoot
          Fixed Value2.16.840.1.113883.1.3
          832. ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.extension
          Definition

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

          Control1..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExtension
          834. 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/cda/stds/core/StructureDefinition/II
          836. ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode
          Control0..1
          BindingThe codes SHALL be taken from EntityClassOrganization
          (required to http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueORG
          838. ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode
          Control0..1
          BindingThe codes SHALL be taken from EntityDeterminer
          (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueINSTANCE
          840. ClinicalDocument.recordTarget.patientRole.providerOrganization.id
          Comments

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

          Control1..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
          842. 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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          844. 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(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelAssigning Authority Name
          846. 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(bl: Boolean)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelDisplayable
          848. 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.

          Comments

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

          Control0..1
          Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelRoot
          Invariantsshould-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6')
          850. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension
          Definition

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

          Control0..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExtension
          852. ClinicalDocument.recordTarget.patientRole.providerOrganization.name
          Comments

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

          Control1..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ON
          854. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom
          Comments

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

          Control1..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
          Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
          856. 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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          858. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value
          Control0..1
          Typeurl(url: Universal Resource Locator)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          860. 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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
          Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
          XML FormatThe type of this property is determined using the xsi:typeattribute.
          LabelUseable Period
          862. 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.

          Comments

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

          Control0..1
          BindingThe codes SHALL be taken from Telecom Use (US Realm Header) .
          (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelUse Code
          864. 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.

          ShortBase for all types and resources
          Comments

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

          Control1..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
          Is Modifierfalse
          Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
          shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
          should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
          should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
          81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
          81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
          81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
          shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
          866. ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode
          Control0..1
          BindingFor example codes, see OrganizationIndustryClassNAICS
          (example to http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          868. ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf
          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
          870. ClinicalDocument.author
          ShortThe author element represents the creator of the clinical document. The author may be a device, or a person. The person is the patient or the patient's advocate.
          Comments

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

          Control1..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
          872. 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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          874. 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/cda/stds/core/StructureDefinition/CS
          876. 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/cda/stds/core/StructureDefinition/II
          InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
          878. ClinicalDocument.author.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          880. ClinicalDocument.author.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(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelAssigning Authority Name
          882. ClinicalDocument.author.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(bl: Boolean)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelDisplayable
          884. ClinicalDocument.author.typeId.root
          Definition

          Identifies the type as an HL7 Registered model

          Control1..1
          Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelRoot
          Fixed Value2.16.840.1.113883.1.3
          886. ClinicalDocument.author.typeId.extension
          Definition

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

          Control1..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExtension
          888. 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/cda/stds/core/StructureDefinition/II
          890. ClinicalDocument.author.typeCode
          Control0..1
          BindingThe codes SHALL be taken from CDAParticipationType
          (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueAUT
          892. ClinicalDocument.author.contextControlCode
          Control0..1
          BindingThe codes SHALL be taken from CDAContextControl
          (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueOP
          894. ClinicalDocument.author.functionCode
          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          896. 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.

          ShortBase for all types and resources
          Comments

          Such authors SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5445).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
          Is Modifierfalse
          Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
          ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
          898. ClinicalDocument.author.assignedAuthor
          Comments

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

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor
          Invariants4537-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). ((assignedPerson | assignedAuthoringDevice).count() = 1)
          should-id-npi: SHOULD contain an id with root='2.16.840.1.113883.4.6' (NPI) (id.where(root = '2.16.840.1.113883.4.6'))
          should-us-code: SHOULD contain code (code.exists())
          should-code: SHOULD contain code (code.exists())
          900. ClinicalDocument.author.assignedAuthor.nullFlavor
          Definition

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

          Control0..1
          BindingThe codes SHALL be taken from CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          902. ClinicalDocument.author.assignedAuthor.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/cda/stds/core/StructureDefinition/CS
          904. ClinicalDocument.author.assignedAuthor.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/cda/stds/core/StructureDefinition/II
          InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
          906. ClinicalDocument.author.assignedAuthor.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 CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          908. ClinicalDocument.author.assignedAuthor.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(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelAssigning Authority Name
          910. ClinicalDocument.author.assignedAuthor.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(bl: Boolean)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelDisplayable
          912. ClinicalDocument.author.assignedAuthor.typeId.root
          Definition

          Identifies the type as an HL7 Registered model

          Control1..1
          Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelRoot
          Fixed Value2.16.840.1.113883.1.3
          914. ClinicalDocument.author.assignedAuthor.typeId.extension
          Definition

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

          Control1..1
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExtension
          916. 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/cda/stds/core/StructureDefinition/II
          918. ClinicalDocument.author.assignedAuthor.classCode
          Control0..1
          BindingThe codes SHALL be taken from RoleClassAssignedEntity
          (required to http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueASSIGNED
          920. ClinicalDocument.author.assignedAuthor.id
          Comments

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

          Control1..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
          SlicingThis element introduces a set of slices on ClinicalDocument.author.assignedAuthor.id. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ root
          • 922. ClinicalDocument.author.assignedAuthor.id:npi
            Slice Namenpi
            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
            Invariantsshould-extension: SHOULD contain extension (extension.exists())
            924. ClinicalDocument.author.assignedAuthor.id:npi.nullFlavor
            Definition

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

            ShortIf NPI is unknown, set @nullFlavor to UNK
            Control0..1
            BindingThe codes SHALL be taken from CDANullFlavor
            (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExceptional Value Detail
            926. ClinicalDocument.author.assignedAuthor.id:npi.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(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelAssigning Authority Name
            928. ClinicalDocument.author.assignedAuthor.id:npi.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(bl: Boolean)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelDisplayable
            930. ClinicalDocument.author.assignedAuthor.id:npi.root
            Definition

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

            Comments

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

            Control1..1
            Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelRoot
            Pattern Value2.16.840.1.113883.4.6
            932. ClinicalDocument.author.assignedAuthor.id:npi.extension
            Definition

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

            Comments

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

            Control0..1
            Typestring(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExtension
            934. ClinicalDocument.author.assignedAuthor.sdtcIdentifiedBy
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
            XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
            936. ClinicalDocument.author.assignedAuthor.code
            ShortWhen the author is a person who is not acting in the role of a clinician, this code encodes the personal or legal relationship between author and the patient.
            Comments

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

            Control0..1
            BindingFor example codes, see CDARoleCode
            (example to http://hl7.org/cda/stds/core/ValueSet/CDARoleCode)
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
            938. 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..0
            BindingThe codes SHALL be taken from CDANullFlavor
            (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExceptional Value Detail
            940. 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 Personal And Legal Relationship Role Type .
            (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelCode
            942. ClinicalDocument.author.assignedAuthor.code.codeSystem
            Definition

            Specifies the code system that defines the code.

            Control0..1
            Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelCode System
            944. ClinicalDocument.author.assignedAuthor.code.codeSystemName
            Definition

            The common name of the coding system.

            Control0..1
            Typestring(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelCode System Name
            946. ClinicalDocument.author.assignedAuthor.code.codeSystemVersion
            Definition

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

            Control0..1
            Typestring(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelCode System Version
            948. 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(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelDisplay Name
            950. 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(oid: ISO Object Identifier)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn 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 namevalueSet.
            952. 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(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn 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 namevalueSetVersion.
            954. ClinicalDocument.author.assignedAuthor.code.originalText
            Definition

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

            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
            LabelOriginal Text
            956. ClinicalDocument.author.assignedAuthor.code.qualifier
            Definition

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

            Control0..0
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
            LabelQualifier
            958. 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/cda/stds/core/StructureDefinition/CD
            XML FormatThe type of this property is determined using the xsi:typeattribute.
            LabelTranslation
            960. 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.

            ShortBase for all types and resources
            Comments

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

            Control1..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
            Is Modifierfalse
            Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
            shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
            should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
            should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
            81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
            81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
            81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
            shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
            962. ClinicalDocument.author.assignedAuthor.telecom
            Comments

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

            Control1..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
            Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
            964. 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 CDANullFlavor
            (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExceptional Value Detail
            966. ClinicalDocument.author.assignedAuthor.telecom.value
            Control0..1
            Typeurl(url: Universal Resource Locator)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            968. 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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
            Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
            XML FormatThe type of this property is determined using the xsi:typeattribute.
            LabelUseable Period
            970. 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.

            Comments

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

            Control0..1
            BindingThe codes SHALL be taken from Telecom Use (US Realm Header) .
            (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelUse Code
            972. ClinicalDocument.author.assignedAuthor.assignedPerson
            Comments

            MAY contain assignedPerson

            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
            974. ClinicalDocument.author.assignedAuthor.assignedPerson.nullFlavor
            Definition

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

            Control0..1
            BindingThe codes SHALL be taken from CDANullFlavor
            (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExceptional Value Detail
            976. ClinicalDocument.author.assignedAuthor.assignedPerson.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/cda/stds/core/StructureDefinition/CS
            978. ClinicalDocument.author.assignedAuthor.assignedPerson.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/cda/stds/core/StructureDefinition/II
            InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
            980. ClinicalDocument.author.assignedAuthor.assignedPerson.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 CDANullFlavor
            (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExceptional Value Detail
            982. ClinicalDocument.author.assignedAuthor.assignedPerson.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(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelAssigning Authority Name
            984. ClinicalDocument.author.assignedAuthor.assignedPerson.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(bl: Boolean)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelDisplayable
            986. ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.root
            Definition

            Identifies the type as an HL7 Registered model

            Control1..1
            Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelRoot
            Fixed Value2.16.840.1.113883.1.3
            988. ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.extension
            Definition

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

            Control1..1
            Typestring(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExtension
            990. 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/cda/stds/core/StructureDefinition/II
            992. ClinicalDocument.author.assignedAuthor.assignedPerson.classCode
            Control0..1
            BindingThe codes SHALL be taken from EntityClassLivingSubject
            (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValuePSN
            994. ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode
            Control0..1
            BindingThe codes SHALL be taken from EntityDeterminer
            (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValueINSTANCE
            996. 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).

            ShortBase for all types and resources
            Comments

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

            Control1..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
            Is Modifierfalse
            Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
            81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
            81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
            998. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcDesc
            Definition

            The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
            XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
            1000. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship
            Definition

            Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
            XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
            1002. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor
            Definition

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

            Control0..1
            BindingThe codes SHALL be taken from CDANullFlavor
            (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExceptional Value Detail
            1004. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/CS
            1006. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/II
            InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
            1008. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor
            (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExceptional Value Detail
            1010. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelAssigning Authority Name
            1012. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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(bl: Boolean)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelDisplayable
            1014. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.root
            Definition

            Identifies the type as an HL7 Registered model

            Control1..1
            Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelRoot
            Fixed Value2.16.840.1.113883.1.3
            1016. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.extension
            Definition

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

            Control1..1
            Typestring(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExtension
            1018. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.templateId
            Definition

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

            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
            1020. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.classCode
            Control1..1
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValuePRS
            1022. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.determinerCode
            Control0..1
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValueINSTANCE
            1024. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.code
            Control1..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
            XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
            1026. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice
            Comments

            MAY contain assignedAuthoringDevice

            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice
            1028. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.nullFlavor
            Definition

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

            Control0..1
            BindingThe codes SHALL be taken from CDANullFlavor
            (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExceptional Value Detail
            1030. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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/cda/stds/core/StructureDefinition/CS
            1032. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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/cda/stds/core/StructureDefinition/II
            InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
            1034. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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 CDANullFlavor
            (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExceptional Value Detail
            1036. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelAssigning Authority Name
            1038. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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(bl: Boolean)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelDisplayable
            1040. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.root
            Definition

            Identifies the type as an HL7 Registered model

            Control1..1
            Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelRoot
            Fixed Value2.16.840.1.113883.1.3
            1042. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.extension
            Definition

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

            Control1..1
            Typestring(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExtension
            1044. 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/cda/stds/core/StructureDefinition/II
            1046. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode
            Control0..1
            BindingThe codes SHALL be taken from EntityClassDevice
            (required to http://terminology.hl7.org/ValueSet/v3-EntityClassDevice)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValueDEV
            1048. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode
            Control0..1
            BindingThe codes SHALL be taken from EntityDeterminer
            (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValueINSTANCE
            1050. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.code
            Control0..1
            BindingFor example codes, see CDAEntityCode
            (example to http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode)
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
            1052. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName
            Comments

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

            Control1..1
            BindingFor example codes, see Manufacturer Model Name Example
            (example to http://terminology.hl7.org/ValueSet/v3-ManufacturerModelNameExample)
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/SC
            1054. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName
            Comments

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

            Control1..1
            BindingFor example codes, see Software Name Example
            (example to http://terminology.hl7.org/ValueSet/v3-SoftwareNameExample)
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/SC
            1056. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/MaintainedEntity
            1058. ClinicalDocument.author.assignedAuthor.representedOrganization
            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
            1060. ClinicalDocument.dataEnterer
            ShortThe dataEnterer element represents the person who transferred the content, written or dictated by someone else, into the clinical document. The guiding rule of thumb is that an author provides the content found within the header or body of the document, subject to their own interpretation, and the dataEnterer adds that information to the electronic system. In other words, a dataEnterer transfers information from one source to another (e.g., transcription from paper form to electronic system). If the dataEnterer is missing, this role is assumed to be played by the author.
            Comments

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

            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/DataEnterer
            1062. 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 CDANullFlavor
            (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExceptional Value Detail
            1064. 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/cda/stds/core/StructureDefinition/CS
            1066. 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/cda/stds/core/StructureDefinition/II
            InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
            1068. ClinicalDocument.dataEnterer.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 CDANullFlavor
            (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExceptional Value Detail
            1070. ClinicalDocument.dataEnterer.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(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelAssigning Authority Name
            1072. ClinicalDocument.dataEnterer.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(bl: Boolean)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelDisplayable
            1074. ClinicalDocument.dataEnterer.typeId.root
            Definition

            Identifies the type as an HL7 Registered model

            Control1..1
            Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelRoot
            Fixed Value2.16.840.1.113883.1.3
            1076. ClinicalDocument.dataEnterer.typeId.extension
            Definition

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

            Control1..1
            Typestring(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExtension
            1078. 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/cda/stds/core/StructureDefinition/II
            1080. ClinicalDocument.dataEnterer.typeCode
            Control0..1
            BindingThe codes SHALL be taken from CDAParticipationType
            (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValueENT
            1082. ClinicalDocument.dataEnterer.contextControlCode
            Control0..1
            BindingThe codes SHALL be taken from CDAContextControl
            (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValueOP
            1084. ClinicalDocument.dataEnterer.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.

            ShortBase for all types and resources
            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
            Is Modifierfalse
            Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
            ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
            1086. ClinicalDocument.dataEnterer.assignedEntity
            Comments

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

            Control1..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
            1088. ClinicalDocument.dataEnterer.assignedEntity.nullFlavor
            Definition

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

            Control0..1
            BindingThe codes SHALL be taken from CDANullFlavor
            (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExceptional Value Detail
            1090. ClinicalDocument.dataEnterer.assignedEntity.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/cda/stds/core/StructureDefinition/CS
            1092. ClinicalDocument.dataEnterer.assignedEntity.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/cda/stds/core/StructureDefinition/II
            InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
            1094. ClinicalDocument.dataEnterer.assignedEntity.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 CDANullFlavor
            (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExceptional Value Detail
            1096. ClinicalDocument.dataEnterer.assignedEntity.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(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelAssigning Authority Name
            1098. ClinicalDocument.dataEnterer.assignedEntity.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(bl: Boolean)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelDisplayable
            1100. ClinicalDocument.dataEnterer.assignedEntity.typeId.root
            Definition

            Identifies the type as an HL7 Registered model

            Control1..1
            Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelRoot
            Fixed Value2.16.840.1.113883.1.3
            1102. ClinicalDocument.dataEnterer.assignedEntity.typeId.extension
            Definition

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

            Control1..1
            Typestring(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExtension
            1104. 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/cda/stds/core/StructureDefinition/II
            1106. ClinicalDocument.dataEnterer.assignedEntity.classCode
            Control0..1
            BindingThe codes SHALL be taken from RoleClassAssignedEntity
            (required to http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValueASSIGNED
            1108. ClinicalDocument.dataEnterer.assignedEntity.id
            Comments

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

            Control1..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
            1110. 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 CDANullFlavor
            (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExceptional Value Detail
            1112. 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(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelAssigning Authority Name
            1114. 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(bl: Boolean)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelDisplayable
            1116. 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.

            Comments

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

            Control0..1
            Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelRoot
            Invariantsshould-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6')
            1118. ClinicalDocument.dataEnterer.assignedEntity.id.extension
            Definition

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

            Control0..1
            Typestring(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExtension
            1120. ClinicalDocument.dataEnterer.assignedEntity.sdtcIdentifiedBy
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
            XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
            1122. ClinicalDocument.dataEnterer.assignedEntity.code
            Comments

            This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28680).

            Control0..1
            BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type .
            (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
            1124. 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.

            ShortBase for all types and resources
            Comments

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

            Control1..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
            Is Modifierfalse
            Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
            shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
            should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
            should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
            81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
            81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
            81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
            shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
            1126. ClinicalDocument.dataEnterer.assignedEntity.telecom
            Comments

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

            Control1..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
            Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
            1128. 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 CDANullFlavor
            (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExceptional Value Detail
            1130. ClinicalDocument.dataEnterer.assignedEntity.telecom.value
            Control0..1
            Typeurl(url: Universal Resource Locator)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            1132. 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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
            Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
            XML FormatThe type of this property is determined using the xsi:typeattribute.
            LabelUseable Period
            1134. 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.

            Comments

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

            Control0..1
            BindingThe codes SHALL be taken from Telecom Use (US Realm Header) .
            (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelUse Code
            1136. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson
            Comments

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

            Control1..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
            1138. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.nullFlavor
            Definition

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

            Control0..1
            BindingThe codes SHALL be taken from CDANullFlavor
            (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExceptional Value Detail
            1140. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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/cda/stds/core/StructureDefinition/CS
            1142. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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/cda/stds/core/StructureDefinition/II
            InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
            1144. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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 CDANullFlavor
            (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExceptional Value Detail
            1146. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelAssigning Authority Name
            1148. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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(bl: Boolean)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelDisplayable
            1150. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.root
            Definition

            Identifies the type as an HL7 Registered model

            Control1..1
            Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelRoot
            Fixed Value2.16.840.1.113883.1.3
            1152. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.extension
            Definition

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

            Control1..1
            Typestring(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExtension
            1154. 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/cda/stds/core/StructureDefinition/II
            1156. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode
            Control0..1
            BindingThe codes SHALL be taken from EntityClassLivingSubject
            (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValuePSN
            1158. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode
            Control0..1
            BindingThe codes SHALL be taken from EntityDeterminer
            (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValueINSTANCE
            1160. 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).

            ShortBase for all types and resources
            Comments

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

            Control1..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
            Is Modifierfalse
            Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
            81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
            81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
            1162. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcDesc
            Definition

            The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
            XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
            1164. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship
            Definition

            Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
            XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
            1166. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor
            Definition

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

            Control0..1
            BindingThe codes SHALL be taken from CDANullFlavor
            (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExceptional Value Detail
            1168. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/CS
            1170. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/II
            InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
            1172. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor
            (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExceptional Value Detail
            1174. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelAssigning Authority Name
            1176. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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(bl: Boolean)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelDisplayable
            1178. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root
            Definition

            Identifies the type as an HL7 Registered model

            Control1..1
            Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelRoot
            Fixed Value2.16.840.1.113883.1.3
            1180. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension
            Definition

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

            Control1..1
            Typestring(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelExtension
            1182. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId
            Definition

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

            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
            1184. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode
            Control1..1
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValuePRS
            1186. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
            Control0..1
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValueINSTANCE
            1188. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
            Control1..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
            XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
            1190. ClinicalDocument.dataEnterer.assignedEntity.representedOrganization
            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
            1192. ClinicalDocument.dataEnterer.assignedEntity.sdtcPatient
            Control0..1
            Typehttp://hl7.org/fhir/StructureDefinition/Base
            XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namepatient.
            1194. ClinicalDocument.dataEnterer.assignedEntity.sdtcPatient.id
            Control1..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
            XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
            1196. ClinicalDocument.informant
            Comments

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

            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
            SlicingThis element introduces a set of slices on ClinicalDocument.informant. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • exists @ relatedEntity
            • exists @ assignedEntity
            • 1198. ClinicalDocument.informant:provider
              Slice Nameprovider
              ShortThe informant element describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient.
              Comments

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
              1200. ClinicalDocument.informant:provider.nullFlavor
              Definition

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

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1202. ClinicalDocument.informant:provider.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/cda/stds/core/StructureDefinition/CS
              1204. ClinicalDocument.informant:provider.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1206. ClinicalDocument.informant:provider.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1208. ClinicalDocument.informant:provider.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1210. ClinicalDocument.informant:provider.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1212. ClinicalDocument.informant:provider.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1214. ClinicalDocument.informant:provider.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1216. ClinicalDocument.informant:provider.templateId
              Definition

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              1218. ClinicalDocument.informant:provider.typeCode
              Control0..1
              BindingThe codes SHALL be taken from CDAParticipationType
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueINF
              1220. ClinicalDocument.informant:provider.contextControlCode
              Control0..1
              BindingThe codes SHALL be taken from CDAContextControl
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueOP
              1222. ClinicalDocument.informant:provider.assignedEntity
              Comments

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

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
              1224. ClinicalDocument.informant:provider.assignedEntity.nullFlavor
              Definition

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

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1226. ClinicalDocument.informant:provider.assignedEntity.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/cda/stds/core/StructureDefinition/CS
              1228. ClinicalDocument.informant:provider.assignedEntity.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1230. ClinicalDocument.informant:provider.assignedEntity.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1232. ClinicalDocument.informant:provider.assignedEntity.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1234. ClinicalDocument.informant:provider.assignedEntity.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1236. ClinicalDocument.informant:provider.assignedEntity.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1238. ClinicalDocument.informant:provider.assignedEntity.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1240. ClinicalDocument.informant:provider.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/cda/stds/core/StructureDefinition/II
              1242. ClinicalDocument.informant:provider.assignedEntity.classCode
              Control0..1
              BindingThe codes SHALL be taken from RoleClassAssignedEntity
              (required to http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueASSIGNED
              1244. ClinicalDocument.informant:provider.assignedEntity.id
              ShortIf 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:4537-9946).
              Comments

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

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              1246. ClinicalDocument.informant:provider.assignedEntity.sdtcIdentifiedBy
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
              1248. ClinicalDocument.informant:provider.assignedEntity.code
              Comments

              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:4537-32174).

              Control0..1
              BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy .
              (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066)
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              1250. ClinicalDocument.informant:provider.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.

              ShortBase for all types and resources
              Comments

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

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
              Is Modifierfalse
              Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
              shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
              should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
              should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
              81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
              81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
              81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
              shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
              1252. ClinicalDocument.informant:provider.assignedEntity.telecom
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
              1254. ClinicalDocument.informant:provider.assignedEntity.assignedPerson
              Comments

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

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
              1256. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.nullFlavor
              Definition

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

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1258. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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/cda/stds/core/StructureDefinition/CS
              1260. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1262. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1264. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1266. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1268. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1270. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1272. ClinicalDocument.informant:provider.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/cda/stds/core/StructureDefinition/II
              1274. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.classCode
              Control0..1
              BindingThe codes SHALL be taken from EntityClassLivingSubject
              (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValuePSN
              1276. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.determinerCode
              Control0..1
              BindingThe codes SHALL be taken from EntityDeterminer
              (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueINSTANCE
              1278. ClinicalDocument.informant:provider.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).

              ShortBase for all types and resources
              Comments

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

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
              Is Modifierfalse
              Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
              81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
              81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
              1280. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcDesc
              Definition

              The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
              1282. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship
              Definition

              Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
              1284. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor
              Definition

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

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1286. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/CS
              1288. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1290. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1292. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1294. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1296. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1298. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1300. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId
              Definition

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              1302. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode
              Control1..1
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValuePRS
              1304. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
              Control0..1
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueINSTANCE
              1306. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
              1308. ClinicalDocument.informant:provider.assignedEntity.representedOrganization
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
              1310. ClinicalDocument.informant:provider.assignedEntity.sdtcPatient
              Control0..1
              Typehttp://hl7.org/fhir/StructureDefinition/Base
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namepatient.
              1312. ClinicalDocument.informant:provider.assignedEntity.sdtcPatient.id
              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
              1314. ClinicalDocument.informant:provider.relatedEntity
              Control0..0
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
              1316. ClinicalDocument.informant:non-provider
              Slice Namenon-provider
              ShortThe informant element describes an information source (who is not a provider) for any content within the clinical document. This informant would be used when the source of information has a personal relationship with the patient or is the patient.
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
              1318. ClinicalDocument.informant:non-provider.nullFlavor
              Definition

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

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1320. ClinicalDocument.informant:non-provider.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/cda/stds/core/StructureDefinition/CS
              1322. ClinicalDocument.informant:non-provider.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1324. ClinicalDocument.informant:non-provider.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1326. ClinicalDocument.informant:non-provider.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1328. ClinicalDocument.informant:non-provider.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1330. ClinicalDocument.informant:non-provider.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1332. ClinicalDocument.informant:non-provider.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1334. ClinicalDocument.informant:non-provider.templateId
              Definition

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              1336. ClinicalDocument.informant:non-provider.typeCode
              Control0..1
              BindingThe codes SHALL be taken from CDAParticipationType
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueINF
              1338. ClinicalDocument.informant:non-provider.contextControlCode
              Control0..1
              BindingThe codes SHALL be taken from CDAContextControl
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueOP
              1340. ClinicalDocument.informant:non-provider.assignedEntity
              Control0..0
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
              1342. ClinicalDocument.informant:non-provider.relatedEntity
              Comments

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

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
              1344. ClinicalDocument.informant:non-provider.relatedEntity.nullFlavor
              Definition

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

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1346. ClinicalDocument.informant:non-provider.relatedEntity.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/cda/stds/core/StructureDefinition/CS
              1348. ClinicalDocument.informant:non-provider.relatedEntity.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1350. ClinicalDocument.informant:non-provider.relatedEntity.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1352. ClinicalDocument.informant:non-provider.relatedEntity.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1354. ClinicalDocument.informant:non-provider.relatedEntity.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1356. ClinicalDocument.informant:non-provider.relatedEntity.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1358. ClinicalDocument.informant:non-provider.relatedEntity.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1360. ClinicalDocument.informant:non-provider.relatedEntity.templateId
              Definition

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              1362. ClinicalDocument.informant:non-provider.relatedEntity.classCode
              Control1..1
              BindingThe codes SHALL be taken from CDARoleClassMutualRelationship
              (required to http://hl7.org/cda/stds/core/ValueSet/CDARoleClassMutualRelationship)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              1364. ClinicalDocument.informant:non-provider.relatedEntity.code
              Comments

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

              Control0..1
              BindingFor example codes, see PersonalRelationshipRoleType
              (example to http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType)
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              Invariantsshould-us-code-attr: SHOULD contain @code (code.exists())
              1366. ClinicalDocument.informant:non-provider.relatedEntity.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1368. ClinicalDocument.informant:non-provider.relatedEntity.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.

              Comments

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

              Control0..1
              BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type .
              (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode
              1370. ClinicalDocument.informant:non-provider.relatedEntity.code.codeSystem
              Definition

              Specifies the code system that defines the code.

              Control0..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System
              1372. ClinicalDocument.informant:non-provider.relatedEntity.code.codeSystemName
              Definition

              The common name of the coding system.

              Control0..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System Name
              1374. ClinicalDocument.informant:non-provider.relatedEntity.code.codeSystemVersion
              Definition

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

              Control0..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System Version
              1376. ClinicalDocument.informant:non-provider.relatedEntity.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplay Name
              1378. ClinicalDocument.informant:non-provider.relatedEntity.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(oid: ISO Object Identifier)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn 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 namevalueSet.
              1380. ClinicalDocument.informant:non-provider.relatedEntity.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn 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 namevalueSetVersion.
              1382. ClinicalDocument.informant:non-provider.relatedEntity.code.originalText
              Definition

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

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
              LabelOriginal Text
              1384. ClinicalDocument.informant:non-provider.relatedEntity.code.qualifier
              Definition

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

              Control0..0
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
              LabelQualifier
              1386. ClinicalDocument.informant:non-provider.relatedEntity.code.translation
              Definition

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
              XML FormatThe type of this property is determined using the xsi:typeattribute.
              LabelTranslation
              1388. ClinicalDocument.informant:non-provider.relatedEntity.addr
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
              1390. ClinicalDocument.informant:non-provider.relatedEntity.telecom
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
              1392. ClinicalDocument.informant:non-provider.relatedEntity.effectiveTime
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
              1394. ClinicalDocument.informant:non-provider.relatedEntity.relatedPerson
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
              1396. ClinicalDocument.custodian
              ShortThe custodian element represents the organization or person that is in charge of maintaining the document. The custodian is the steward that is entrusted with the care of the document. Every CDA document has exactly one custodian. The custodian participation satisfies the CDA definition of Stewardship. Because CDA is an exchange standard and may not represent the original form of the authenticated document (e.g., CDA could include scanned copy of original), the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party. Also, the custodian may be the patient or an organization acting on behalf of the patient, such as a PHR organization.
              Comments

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

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Custodian
              1398. 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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1400. 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/cda/stds/core/StructureDefinition/CS
              1402. 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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1404. ClinicalDocument.custodian.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1406. ClinicalDocument.custodian.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1408. ClinicalDocument.custodian.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1410. ClinicalDocument.custodian.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1412. ClinicalDocument.custodian.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1414. 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/cda/stds/core/StructureDefinition/II
              1416. ClinicalDocument.custodian.typeCode
              Control0..1
              BindingThe codes SHALL be taken from CDAParticipationType
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueCST
              1418. ClinicalDocument.custodian.assignedCustodian
              Comments

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

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedCustodian
              1420. ClinicalDocument.custodian.assignedCustodian.nullFlavor
              Definition

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

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1422. ClinicalDocument.custodian.assignedCustodian.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/cda/stds/core/StructureDefinition/CS
              1424. ClinicalDocument.custodian.assignedCustodian.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1426. ClinicalDocument.custodian.assignedCustodian.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1428. ClinicalDocument.custodian.assignedCustodian.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1430. ClinicalDocument.custodian.assignedCustodian.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1432. ClinicalDocument.custodian.assignedCustodian.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1434. ClinicalDocument.custodian.assignedCustodian.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1436. 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/cda/stds/core/StructureDefinition/II
              1438. ClinicalDocument.custodian.assignedCustodian.classCode
              Control0..1
              BindingThe codes SHALL be taken from RoleClassAssignedEntity
              (required to http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueASSIGNED
              1440. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
              ShortThe representedCustodianOrganization may be the person when the document is not maintained by an organization.
              Comments

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

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CustodianOrganization
              1442. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.nullFlavor
              Definition

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

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1444. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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/cda/stds/core/StructureDefinition/CS
              1446. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1448. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1450. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1452. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1454. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1456. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1458. 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/cda/stds/core/StructureDefinition/II
              1460. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode
              Control0..1
              BindingThe codes SHALL be taken from EntityClassOrganization
              (required to http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueORG
              1462. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode
              Control0..1
              BindingThe codes SHALL be taken from EntityDeterminer
              (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueINSTANCE
              1464. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
              ShortThe combined @root and @extension attributes record the custodian organization's identity in a secure, trusted, and unique way.
              Comments

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

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              1466. 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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1468. 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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1470. 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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1472. 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.

              Comments

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

              Control0..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Invariantsshould-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6')
              1474. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.extension
              Definition

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

              Control0..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1476. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name
              Comments

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

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ON
              1478. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom
              Comments

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

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
              Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
              1480. 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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1482. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.value
              Control0..1
              Typeurl(url: Universal Resource Locator)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              1484. 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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
              Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
              XML FormatThe type of this property is determined using the xsi:typeattribute.
              LabelUseable Period
              1486. 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.

              Comments

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

              Control0..1
              BindingThe codes SHALL be taken from Telecom Use (US Realm Header) .
              (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelUse Code
              1488. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.sdtcTelecom
              ShortThe stdc:telecom extension can be used to provide additional telecom elements for the custodian organization.
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nametelecom.
              1490. 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.

              ShortBase for all types and resources
              Comments

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

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
              Is Modifierfalse
              Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
              shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
              should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
              should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
              81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
              81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
              81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
              shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
              1492. ClinicalDocument.informationRecipient
              ShortThe informationRecipient element records the intended recipient of the information at the time the document is created. For example, in cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to be the scoping organization for that chart.
              Comments

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient
              1494. 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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1496. 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/cda/stds/core/StructureDefinition/CS
              1498. 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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1500. ClinicalDocument.informationRecipient.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1502. ClinicalDocument.informationRecipient.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1504. ClinicalDocument.informationRecipient.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1506. ClinicalDocument.informationRecipient.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1508. ClinicalDocument.informationRecipient.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1510. 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/cda/stds/core/StructureDefinition/II
              1512. ClinicalDocument.informationRecipient.typeCode
              Control0..1
              BindingThe codes SHALL be taken from XInformationRecipient (2.0.0)
              (required to http://terminology.hl7.org/ValueSet/v3-xInformationRecipient|2.0.0)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Default ValuePRCP
              1514. ClinicalDocument.informationRecipient.intendedRecipient
              Comments

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

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/IntendedRecipient
              Invariantsshould-id: SHOULD contain id (id.exists())
              1516. ClinicalDocument.informationRecipient.intendedRecipient.nullFlavor
              Definition

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

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1518. ClinicalDocument.informationRecipient.intendedRecipient.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/cda/stds/core/StructureDefinition/CS
              1520. ClinicalDocument.informationRecipient.intendedRecipient.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1522. ClinicalDocument.informationRecipient.intendedRecipient.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1524. ClinicalDocument.informationRecipient.intendedRecipient.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1526. ClinicalDocument.informationRecipient.intendedRecipient.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1528. ClinicalDocument.informationRecipient.intendedRecipient.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1530. ClinicalDocument.informationRecipient.intendedRecipient.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1532. 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/cda/stds/core/StructureDefinition/II
              1534. ClinicalDocument.informationRecipient.intendedRecipient.classCode
              Control0..1
              BindingThe codes SHALL be taken from CDAInformationRecipientRole
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAInformationRecipientRole)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Default ValueASSIGNED
              1536. ClinicalDocument.informationRecipient.intendedRecipient.id
              ShortThe combined @root and @extension attributes to record the information recipient's identity in a secure, trusted, and unique way.
              Comments

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              Invariantsshould-root: SHOULD contain @root (root.exists())
              1538. ClinicalDocument.informationRecipient.intendedRecipient.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1540. ClinicalDocument.informationRecipient.intendedRecipient.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1542. ClinicalDocument.informationRecipient.intendedRecipient.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1544. ClinicalDocument.informationRecipient.intendedRecipient.id.root
              Definition

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

              ShortFor a provider, the id/@root ="2.16.840.1.113883.4.6" indicates the National Provider Identifier where id/@extension is the NPI number for the provider. The ids MAY reference the id of a person or organization entity specified elsewhere in the document.
              Comments

              The id, if present, SHOULD contain zero or one [0..1] @root (CONF:1198-28693).

              Control0..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              1546. ClinicalDocument.informationRecipient.intendedRecipient.id.extension
              Definition

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

              Control0..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1548. ClinicalDocument.informationRecipient.intendedRecipient.sdtcIdentifiedBy
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
              1550. ClinicalDocument.informationRecipient.intendedRecipient.addr
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
              1552. ClinicalDocument.informationRecipient.intendedRecipient.telecom
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
              1554. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient
              Comments

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

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
              1556. ClinicalDocument.informationRecipient.intendedRecipient.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1558. ClinicalDocument.informationRecipient.intendedRecipient.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/cda/stds/core/StructureDefinition/CS
              1560. ClinicalDocument.informationRecipient.intendedRecipient.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1562. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1564. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1566. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1568. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1570. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1572. 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/cda/stds/core/StructureDefinition/II
              1574. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode
              Control0..1
              BindingThe codes SHALL be taken from EntityClassLivingSubject
              (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValuePSN
              1576. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode
              Control0..1
              BindingThe codes SHALL be taken from EntityDeterminer
              (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueINSTANCE
              1578. 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).

              ShortBase for all types and resources
              Comments

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

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
              Is Modifierfalse
              Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
              81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
              81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
              1580. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcDesc
              Definition

              The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
              1582. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship
              Definition

              Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
              1584. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.nullFlavor
              Definition

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

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1586. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/CS
              1588. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1590. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1592. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1594. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1596. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1598. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1600. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.templateId
              Definition

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              1602. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.classCode
              Control1..1
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValuePRS
              1604. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.determinerCode
              Control0..1
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueINSTANCE
              1606. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.code
              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
              1608. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization
              Comments

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

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
              1610. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.nullFlavor
              Definition

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

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1612. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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/cda/stds/core/StructureDefinition/CS
              1614. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1616. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1618. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1620. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1622. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1624. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1626. 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/cda/stds/core/StructureDefinition/II
              1628. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode
              Control0..1
              BindingThe codes SHALL be taken from EntityClassOrganization
              (required to http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueORG
              1630. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode
              Control0..1
              BindingThe codes SHALL be taken from EntityDeterminer
              (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueINSTANCE
              1632. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              1634. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name
              Comments

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

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ON
              1636. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
              1638. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
              1640. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCode
              Control0..1
              BindingFor example codes, see OrganizationIndustryClassNAICS
              (example to http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS)
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              1642. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
              1644. ClinicalDocument.legalAuthenticator
              ShortIn a patient authored document, the legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. (Note that per the following section, there may also be one or more document authenticators.) Based on local practice, patient authored documents may be provided without legal authentication. This implies that a patient authored document that does not contain this element has not been legally authenticated. The act of legal authentication requires a certain privilege be granted to the legal authenticator depending upon local policy. All patient documents have the potential for legal authentication, given the appropriate legal authority. Local policies MAY choose to delegate the function of legal authentication to a device or system that generates the document. In these cases, the legal authenticator is the person accepting responsibility for the document, not the generating device or system. Note that the legal authenticator, if present, must be a person.
              Comments

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

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator
              1646. 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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1648. 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/cda/stds/core/StructureDefinition/CS
              1650. 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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1652. ClinicalDocument.legalAuthenticator.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1654. ClinicalDocument.legalAuthenticator.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1656. ClinicalDocument.legalAuthenticator.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1658. ClinicalDocument.legalAuthenticator.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1660. ClinicalDocument.legalAuthenticator.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1662. 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/cda/stds/core/StructureDefinition/II
              1664. ClinicalDocument.legalAuthenticator.typeCode
              Control0..1
              BindingThe codes SHALL be taken from CDAParticipationType
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueLA
              1666. ClinicalDocument.legalAuthenticator.contextControlCode
              Control0..1
              BindingThe codes SHALL be taken from CDAContextControl
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueOP
              1668. 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.

              ShortBase for all types and resources
              Comments

              The legalAuthenticator, if present, SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5580).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
              Is Modifierfalse
              Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
              ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
              1670. ClinicalDocument.legalAuthenticator.signatureCode
              Comments

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

              Control1..1
              BindingThe codes SHALL be taken from CDASignatureCode
              (required to http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode)
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
              Invariantssignature: CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. (code.exists() implies code != 'X')
              1672. 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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1674. 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.

              Comments

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

              Control1..1
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode
              Pattern ValueS
              1676. ClinicalDocument.legalAuthenticator.signatureCode.codeSystem
              Definition

              Specifies the code system that defines the code.

              Control0..0
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System
              1678. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemName
              Definition

              The common name of the coding system.

              Control0..0
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System Name
              1680. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemVersion
              Definition

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

              Control0..0
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System Version
              1682. 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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplay Name
              1684. 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(oid: ISO Object Identifier)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn 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 namevalueSet.
              1686. 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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn 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 namevalueSetVersion.
              1688. ClinicalDocument.legalAuthenticator.signatureCode.originalText
              Definition

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

              Control0..0
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
              LabelOriginal Text
              1690. ClinicalDocument.legalAuthenticator.signatureCode.qualifier
              Definition

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

              Control0..0
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
              LabelQualifier
              1692. 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/cda/stds/core/StructureDefinition/CD
              XML FormatThe type of this property is determined using the xsi:typeattribute.
              LabelTranslation
              1694. ClinicalDocument.legalAuthenticator.sdtcSignatureText
              Definition

              A textual or multimedia depiction of the signature by which the participant endorses his or her participation in the Act as specified in the Participation.typeCode and that he or she agrees to assume the associated accountability.

              ShortThe signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall 2013.
              Comments

              The legalAuthenticator, if present, MAY contain zero or one [0..1] sdtc:signatureText (CONF:4537-30810).

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namesignatureText.
              1696. ClinicalDocument.legalAuthenticator.assignedEntity
              Comments

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

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
              1698. ClinicalDocument.legalAuthenticator.assignedEntity.nullFlavor
              Definition

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

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1700. ClinicalDocument.legalAuthenticator.assignedEntity.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/cda/stds/core/StructureDefinition/CS
              1702. ClinicalDocument.legalAuthenticator.assignedEntity.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1704. ClinicalDocument.legalAuthenticator.assignedEntity.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1706. ClinicalDocument.legalAuthenticator.assignedEntity.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1708. ClinicalDocument.legalAuthenticator.assignedEntity.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1710. ClinicalDocument.legalAuthenticator.assignedEntity.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1712. ClinicalDocument.legalAuthenticator.assignedEntity.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1714. 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/cda/stds/core/StructureDefinition/II
              1716. ClinicalDocument.legalAuthenticator.assignedEntity.classCode
              Control0..1
              BindingThe codes SHALL be taken from RoleClassAssignedEntity
              (required to http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueASSIGNED
              1718. ClinicalDocument.legalAuthenticator.assignedEntity.id
              ShortThe combined @root and @extension attributes to record the information recipient's identity in a secure, trusted, and unique way.
              Comments

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

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              1720. 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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1722. 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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1724. 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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1726. 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.

              ShortMAY contain '2.16.840.1.113883.4.6' (NPI)
              Comments

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

              Control0..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              1728. ClinicalDocument.legalAuthenticator.assignedEntity.id.extension
              Definition

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

              Control0..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1730. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcIdentifiedBy
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
              1732. ClinicalDocument.legalAuthenticator.assignedEntity.code
              Comments

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

              Control0..1
              BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy .
              (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066)
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              1734. ClinicalDocument.legalAuthenticator.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1736. ClinicalDocument.legalAuthenticator.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.

              Comments

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

              Control0..1
              BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type .
              (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode
              1738. ClinicalDocument.legalAuthenticator.assignedEntity.code.codeSystem
              Definition

              Specifies the code system that defines the code.

              Control0..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System
              1740. ClinicalDocument.legalAuthenticator.assignedEntity.code.codeSystemName
              Definition

              The common name of the coding system.

              Control0..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System Name
              1742. ClinicalDocument.legalAuthenticator.assignedEntity.code.codeSystemVersion
              Definition

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

              Control0..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System Version
              1744. ClinicalDocument.legalAuthenticator.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplay Name
              1746. ClinicalDocument.legalAuthenticator.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(oid: ISO Object Identifier)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn 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 namevalueSet.
              1748. ClinicalDocument.legalAuthenticator.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn 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 namevalueSetVersion.
              1750. ClinicalDocument.legalAuthenticator.assignedEntity.code.originalText
              Definition

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

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
              LabelOriginal Text
              1752. ClinicalDocument.legalAuthenticator.assignedEntity.code.qualifier
              Definition

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

              Control0..0
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
              LabelQualifier
              1754. ClinicalDocument.legalAuthenticator.assignedEntity.code.translation
              Definition

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
              XML FormatThe type of this property is determined using the xsi:typeattribute.
              LabelTranslation
              1756. 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.

              ShortBase for all types and resources
              Comments

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

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
              Is Modifierfalse
              Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
              shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
              should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
              should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
              81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
              81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
              81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
              shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
              1758. ClinicalDocument.legalAuthenticator.assignedEntity.telecom
              Comments

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

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
              Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
              1760. 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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1762. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.value
              Control0..1
              Typeurl(url: Universal Resource Locator)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              1764. 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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
              Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
              XML FormatThe type of this property is determined using the xsi:typeattribute.
              LabelUseable Period
              1766. 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.

              Comments

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

              Control0..1
              BindingThe codes SHALL be taken from Telecom Use (US Realm Header) .
              (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelUse Code
              1768. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson
              Comments

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

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
              1770. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.nullFlavor
              Definition

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

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1772. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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/cda/stds/core/StructureDefinition/CS
              1774. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1776. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1778. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1780. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1782. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1784. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1786. 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/cda/stds/core/StructureDefinition/II
              1788. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode
              Control0..1
              BindingThe codes SHALL be taken from EntityClassLivingSubject
              (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValuePSN
              1790. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode
              Control0..1
              BindingThe codes SHALL be taken from EntityDeterminer
              (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueINSTANCE
              1792. 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).

              ShortBase for all types and resources
              Comments

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

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
              Is Modifierfalse
              Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
              81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
              81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
              1794. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcDesc
              Definition

              The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
              1796. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship
              Definition

              Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
              1798. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor
              Definition

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

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1800. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/CS
              1802. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1804. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1806. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1808. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1810. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1812. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1814. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId
              Definition

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              1816. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode
              Control1..1
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValuePRS
              1818. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
              Control0..1
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueINSTANCE
              1820. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
              1822. ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
              1824. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcPatient
              Control0..1
              Typehttp://hl7.org/fhir/StructureDefinition/Base
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namepatient.
              1826. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcPatient.id
              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
              1828. ClinicalDocument.authenticator
              ShortThe authenticator identifies a participant or participants who attest to the accuracy of the information in the document.
              Comments

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authenticator
              1830. ClinicalDocument.authenticator.nullFlavor
              Definition

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

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1832. ClinicalDocument.authenticator.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/cda/stds/core/StructureDefinition/CS
              1834. ClinicalDocument.authenticator.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1836. ClinicalDocument.authenticator.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1838. ClinicalDocument.authenticator.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1840. ClinicalDocument.authenticator.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1842. ClinicalDocument.authenticator.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1844. ClinicalDocument.authenticator.typeId.extension
              Definition

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

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1846. ClinicalDocument.authenticator.templateId
              Definition

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              1848. ClinicalDocument.authenticator.typeCode
              Control0..1
              BindingThe codes SHALL be taken from CDAParticipationType
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueAUTHEN
              1850. ClinicalDocument.authenticator.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.

              ShortBase for all types and resources
              Comments

              SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5608).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
              Is Modifierfalse
              Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
              ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
              1852. ClinicalDocument.authenticator.signatureCode
              Comments

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

              Control1..1
              BindingThe codes SHALL be taken from CDASignatureCode
              (required to http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode)
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
              Invariantssignature: CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. (code.exists() implies code != 'X')
              1854. ClinicalDocument.authenticator.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1856. ClinicalDocument.authenticator.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.

              Comments

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

              Control1..1
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode
              Pattern ValueS
              1858. ClinicalDocument.authenticator.signatureCode.codeSystem
              Definition

              Specifies the code system that defines the code.

              Control0..0
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System
              1860. ClinicalDocument.authenticator.signatureCode.codeSystemName
              Definition

              The common name of the coding system.

              Control0..0
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System Name
              1862. ClinicalDocument.authenticator.signatureCode.codeSystemVersion
              Definition

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

              Control0..0
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System Version
              1864. ClinicalDocument.authenticator.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplay Name
              1866. ClinicalDocument.authenticator.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(oid: ISO Object Identifier)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn 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 namevalueSet.
              1868. ClinicalDocument.authenticator.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn 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 namevalueSetVersion.
              1870. ClinicalDocument.authenticator.signatureCode.originalText
              Definition

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

              Control0..0
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
              LabelOriginal Text
              1872. ClinicalDocument.authenticator.signatureCode.qualifier
              Definition

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

              Control0..0
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
              LabelQualifier
              1874. ClinicalDocument.authenticator.signatureCode.translation
              Definition

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

              Control0..0
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
              XML FormatThe type of this property is determined using the xsi:typeattribute.
              LabelTranslation
              1876. ClinicalDocument.authenticator.sdtcSignatureText
              Definition

              A textual or multimedia depiction of the signature by which the participant endorses his or her participation in the Act as specified in the Participation.typeCode and that he or she agrees to assume the associated accountability.

              ShortThe signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall of 2013.
              Comments

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

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namesignatureText.
              1878. ClinicalDocument.authenticator.assignedEntity
              Comments

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

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
              Invariantsshould-code: SHOULD contain code (code.exists())
              1880. ClinicalDocument.authenticator.assignedEntity.nullFlavor
              Definition

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

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1882. ClinicalDocument.authenticator.assignedEntity.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/cda/stds/core/StructureDefinition/CS
              1884. ClinicalDocument.authenticator.assignedEntity.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1886. ClinicalDocument.authenticator.assignedEntity.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1888. ClinicalDocument.authenticator.assignedEntity.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1890. ClinicalDocument.authenticator.assignedEntity.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1892. ClinicalDocument.authenticator.assignedEntity.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1894. ClinicalDocument.authenticator.assignedEntity.typeId.extension
              Definition

              A character string as a unique identifier within the scope of the identifier root.

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1896. ClinicalDocument.authenticator.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/cda/stds/core/StructureDefinition/II
              1898. ClinicalDocument.authenticator.assignedEntity.classCode
              Control0..1
              BindingThe codes SHALL be taken from RoleClassAssignedEntity
              (required to http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueASSIGNED
              1900. ClinicalDocument.authenticator.assignedEntity.id
              ShortThe combined @root and @extension attributes to record the authenticator's identity in a secure, trusted, and unique way.
              Comments

              This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28701).

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              1902. ClinicalDocument.authenticator.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1904. ClinicalDocument.authenticator.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1906. ClinicalDocument.authenticator.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1908. ClinicalDocument.authenticator.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.

              Comments

              Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16824).

              Control0..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Invariantsshould-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6')
              1910. ClinicalDocument.authenticator.assignedEntity.id.extension
              Definition

              A character string as a unique identifier within the scope of the identifier root.

              Control0..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1912. ClinicalDocument.authenticator.assignedEntity.sdtcIdentifiedBy
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
              1914. ClinicalDocument.authenticator.assignedEntity.code
              Comments

              This assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28702).

              Control0..1
              BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type .
              (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              1916. ClinicalDocument.authenticator.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1918. ClinicalDocument.authenticator.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.

              Comments

              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:4537-16826).

              Control0..1
              BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy .
              (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode
              1920. ClinicalDocument.authenticator.assignedEntity.code.codeSystem
              Definition

              Specifies the code system that defines the code.

              Control0..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System
              1922. ClinicalDocument.authenticator.assignedEntity.code.codeSystemName
              Definition

              The common name of the coding system.

              Control0..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System Name
              1924. ClinicalDocument.authenticator.assignedEntity.code.codeSystemVersion
              Definition

              If applicable, a version descriptor defined specifically for the given code system.

              Control0..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System Version
              1926. ClinicalDocument.authenticator.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplay Name
              1928. ClinicalDocument.authenticator.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(oid: ISO Object Identifier)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn 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 namevalueSet.
              1930. ClinicalDocument.authenticator.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn 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 namevalueSetVersion.
              1932. ClinicalDocument.authenticator.assignedEntity.code.originalText
              Definition

              The text or phrase used as the basis for the coding.

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
              LabelOriginal Text
              1934. ClinicalDocument.authenticator.assignedEntity.code.qualifier
              Definition

              Specifies additional codes that increase the specificity of the the primary code.

              Control0..0
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
              LabelQualifier
              1936. ClinicalDocument.authenticator.assignedEntity.code.translation
              Definition

              A set of other concept descriptors that translate this concept descriptor into other code systems.

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
              XML FormatThe type of this property is determined using the xsi:typeattribute.
              LabelTranslation
              1938. ClinicalDocument.authenticator.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.

              ShortBase for all types and resources
              Comments

              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:4537-5616).

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
              Is Modifierfalse
              Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
              shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
              should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
              should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
              81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
              81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
              81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
              shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
              1940. ClinicalDocument.authenticator.assignedEntity.telecom
              Comments

              This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5622).

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
              Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
              1942. ClinicalDocument.authenticator.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1944. ClinicalDocument.authenticator.assignedEntity.telecom.value
              Control0..1
              Typeurl(url: Universal Resource Locator)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              1946. ClinicalDocument.authenticator.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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
              Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
              XML FormatThe type of this property is determined using the xsi:typeattribute.
              LabelUseable Period
              1948. ClinicalDocument.authenticator.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.

              Comments

              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:4537-8000).

              Control0..1
              BindingThe codes SHALL be taken from Telecom Use (US Realm Header) .
              (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelUse Code
              1950. ClinicalDocument.authenticator.assignedEntity.assignedPerson
              Comments

              This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5624).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
              1952. ClinicalDocument.authenticator.assignedEntity.assignedPerson.nullFlavor
              Definition

              If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1954. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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/cda/stds/core/StructureDefinition/CS
              1956. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1958. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1960. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1962. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1964. ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1966. ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.extension
              Definition

              A character string as a unique identifier within the scope of the identifier root.

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1968. ClinicalDocument.authenticator.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/cda/stds/core/StructureDefinition/II
              1970. ClinicalDocument.authenticator.assignedEntity.assignedPerson.classCode
              Control0..1
              BindingThe codes SHALL be taken from EntityClassLivingSubject
              (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValuePSN
              1972. ClinicalDocument.authenticator.assignedEntity.assignedPerson.determinerCode
              Control0..1
              BindingThe codes SHALL be taken from EntityDeterminer
              (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueINSTANCE
              1974. ClinicalDocument.authenticator.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).

              ShortBase for all types and resources
              Comments

              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:4537-5625).

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
              Is Modifierfalse
              Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
              81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
              81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
              1976. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcDesc
              Definition

              The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
              1978. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship
              Definition

              Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
              1980. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor
              Definition

              If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1982. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/CS
              1984. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              1986. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              1988. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              1990. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              1992. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              1994. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension
              Definition

              A character string as a unique identifier within the scope of the identifier root.

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              1996. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId
              Definition

              When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              1998. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode
              Control1..1
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValuePRS
              2000. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
              Control0..1
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueINSTANCE
              2002. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
              2004. ClinicalDocument.authenticator.assignedEntity.representedOrganization
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
              2006. ClinicalDocument.authenticator.assignedEntity.sdtcPatient
              Control0..1
              Typehttp://hl7.org/fhir/StructureDefinition/Base
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namepatient.
              2008. ClinicalDocument.authenticator.assignedEntity.sdtcPatient.id
              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
              2010. ClinicalDocument.participant
              ShortThe participant element identifies other supporting participants, including parents, relatives, caregivers, insurance policyholders, guarantors, and other participants related in some way to the patient. A supporting person or organization is an individual or an organization with a relationship to the patient. A supporting person who is playing multiple roles would be recorded in multiple participants (e.g., emergency contact and next-of-kin)
              Comments

              MAY contain zero or more [0..*] participant (CONF:1198-28703).

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant1
              Invariants4537-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). (associatedEntity.associatedPerson.exists() or associatedEntity.scopingOrganization.exists())
              4537-10007: When participant/@typeCode is *IND*, associatedEntity/@classCode **SHOULD** be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *DYNAMIC* (CONF:4537-10007). (typeCode = 'IND' implies associatedEntity.classCode.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.33'))
              2012. ClinicalDocument.participant.nullFlavor
              Definition

              If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2014. ClinicalDocument.participant.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/cda/stds/core/StructureDefinition/CS
              2016. ClinicalDocument.participant.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              2018. ClinicalDocument.participant.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2020. ClinicalDocument.participant.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              2022. ClinicalDocument.participant.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              2024. ClinicalDocument.participant.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              2026. ClinicalDocument.participant.typeId.extension
              Definition

              A character string as a unique identifier within the scope of the identifier root.

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              2028. ClinicalDocument.participant.templateId
              Definition

              When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              2030. ClinicalDocument.participant.typeCode
              ShortUnless otherwise specified by the document specific header constraints, when participant/@typeCode is IND, associatedEntity/@classCode SHALL be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes STATIC 2011-09-30
              Comments

              The participant, if present, SHALL contain exactly one [1..1] @typeCode (CONF:1198-28704).

              Control1..1
              BindingThe codes SHALL be taken from CDAParticipationType
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              2032. ClinicalDocument.participant.contextControlCode
              Control0..1
              BindingThe codes SHALL be taken from CDAContextControl
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueOP
              2034. ClinicalDocument.participant.functionCode
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              2036. ClinicalDocument.participant.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.

              ShortBase for all types and resources
              Comments

              MAY contain zero or one [0..1] time (CONF:4537-10004).

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
              Is Modifierfalse
              Invariantsivl-ts-center: Center cannot co-exist with low or high (center.empty() or (low.empty() and high.empty()))
              ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. (value.exists() implies value.toString().length() >= 10)
              ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component. (value.exists() implies value.toString().length() > 10)
              2038. ClinicalDocument.participant.associatedEntity
              Comments

              The participant, if present, SHALL contain exactly one [1..1] associatedEntity (CONF:1198-28705).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
              Invariantsshould-code: SHOULD contain code (code.exists())
              2040. ClinicalDocument.participant.associatedEntity.nullFlavor
              Definition

              If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2042. ClinicalDocument.participant.associatedEntity.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/cda/stds/core/StructureDefinition/CS
              2044. ClinicalDocument.participant.associatedEntity.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              2046. ClinicalDocument.participant.associatedEntity.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2048. ClinicalDocument.participant.associatedEntity.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              2050. ClinicalDocument.participant.associatedEntity.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              2052. ClinicalDocument.participant.associatedEntity.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              2054. ClinicalDocument.participant.associatedEntity.typeId.extension
              Definition

              A character string as a unique identifier within the scope of the identifier root.

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              2056. ClinicalDocument.participant.associatedEntity.templateId
              Definition

              When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              2058. ClinicalDocument.participant.associatedEntity.classCode
              Control1..1
              BindingThe codes SHALL be taken from CDARoleClassAssociative
              (required to http://hl7.org/cda/stds/core/ValueSet/CDARoleClassAssociative)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              2060. ClinicalDocument.participant.associatedEntity.id
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              2062. ClinicalDocument.participant.associatedEntity.sdtcIdentifiedBy
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
              2064. ClinicalDocument.participant.associatedEntity.code
              Comments

              This associatedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28706).

              Control0..1
              BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type .
              (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              2066. ClinicalDocument.participant.associatedEntity.addr
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
              2068. ClinicalDocument.participant.associatedEntity.telecom
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
              2070. ClinicalDocument.participant.associatedEntity.associatedPerson
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
              2072. ClinicalDocument.participant.associatedEntity.scopingOrganization
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
              2074. ClinicalDocument.inFulfillmentOf
              ShortThe inFulfillmentOf element represents orders that are fulfilled by this document such as a radiologists' report of an x-ray.
              Comments

              MAY contain zero or more [0..*] inFulfillmentOf (CONF:1198-28707).

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf
              2076. 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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2078. 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/cda/stds/core/StructureDefinition/CS
              2080. 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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              2082. ClinicalDocument.inFulfillmentOf.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2084. ClinicalDocument.inFulfillmentOf.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              2086. ClinicalDocument.inFulfillmentOf.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              2088. ClinicalDocument.inFulfillmentOf.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              2090. ClinicalDocument.inFulfillmentOf.typeId.extension
              Definition

              A character string as a unique identifier within the scope of the identifier root.

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              2092. 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/cda/stds/core/StructureDefinition/II
              2094. ClinicalDocument.inFulfillmentOf.typeCode
              Control0..1
              BindingThe codes SHALL be taken from ActRelationshipFulfills (2.0.0)
              (required to http://terminology.hl7.org/ValueSet/v3-ActRelationshipFulfills|2.0.0)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueFLFS
              2096. ClinicalDocument.inFulfillmentOf.order
              Comments

              The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:1198-28708).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Order
              2098. ClinicalDocument.inFulfillmentOf.order.nullFlavor
              Definition

              If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2100. ClinicalDocument.inFulfillmentOf.order.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/cda/stds/core/StructureDefinition/CS
              2102. ClinicalDocument.inFulfillmentOf.order.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              2104. ClinicalDocument.inFulfillmentOf.order.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2106. ClinicalDocument.inFulfillmentOf.order.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              2108. ClinicalDocument.inFulfillmentOf.order.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              2110. ClinicalDocument.inFulfillmentOf.order.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              2112. ClinicalDocument.inFulfillmentOf.order.typeId.extension
              Definition

              A character string as a unique identifier within the scope of the identifier root.

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              2114. 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/cda/stds/core/StructureDefinition/II
              2116. ClinicalDocument.inFulfillmentOf.order.classCode
              Control0..1
              BindingThe codes SHALL be taken from CDAActClass
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Default ValueACT
              2118. ClinicalDocument.inFulfillmentOf.order.moodCode
              Control0..1
              BindingThe codes SHALL be taken from CDAActMoodIntent
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAActMoodIntent)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueRQO
              2120. ClinicalDocument.inFulfillmentOf.order.id
              ShortA scheduled appointment or service event in a practice management system may be represented using this id element.
              Comments

              This order SHALL contain at least one [1..*] id (CONF:1198-28709).

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              2122. ClinicalDocument.inFulfillmentOf.order.code
              Control0..1
              BindingFor example codes, see v3 Code System ActCode
              (example to http://terminology.hl7.org/ValueSet/v3-ActCode)
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              2124. ClinicalDocument.inFulfillmentOf.order.priorityCode
              Control0..1
              BindingFor example codes, see ActPriority
              (example to http://terminology.hl7.org/ValueSet/v3-ActPriority)
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              2126. ClinicalDocument.documentationOf
              Comments

              MAY contain zero or more [0..*] documentationOf (CONF:1198-28710).

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf
              2128. 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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2130. 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/cda/stds/core/StructureDefinition/CS
              2132. 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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              2134. ClinicalDocument.documentationOf.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2136. ClinicalDocument.documentationOf.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              2138. ClinicalDocument.documentationOf.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              2140. ClinicalDocument.documentationOf.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              2142. ClinicalDocument.documentationOf.typeId.extension
              Definition

              A character string as a unique identifier within the scope of the identifier root.

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              2144. 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/cda/stds/core/StructureDefinition/II
              2146. ClinicalDocument.documentationOf.typeCode
              Control0..1
              BindingThe codes SHALL be taken from CDAActRelationshipType
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueDOC
              2148. ClinicalDocument.documentationOf.serviceEvent
              ShortA serviceEvent represents the main act being documented, such as a colonoscopy or a cardiac stress study. In a provision of healthcare serviceEvent, the care providers, PCP, or other longitudinal providers, are recorded within the serviceEvent. If the document is about a single encounter, the providers associated can be recorded in the componentOf/encompassingEncounter template.
              Comments

              The documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:1198-28711).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent
              Invariantsshould-us-performer: SHOULD contain performer (performer.exists())
              should-code: SHOULD contain code (code.exists())
              should-performer: SHOULD contain performer (performer.exists())
              2150. ClinicalDocument.documentationOf.serviceEvent.nullFlavor
              Definition

              If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2152. ClinicalDocument.documentationOf.serviceEvent.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/cda/stds/core/StructureDefinition/CS
              2154. ClinicalDocument.documentationOf.serviceEvent.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              2156. ClinicalDocument.documentationOf.serviceEvent.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2158. ClinicalDocument.documentationOf.serviceEvent.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              2160. ClinicalDocument.documentationOf.serviceEvent.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              2162. ClinicalDocument.documentationOf.serviceEvent.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              2164. ClinicalDocument.documentationOf.serviceEvent.typeId.extension
              Definition

              A character string as a unique identifier within the scope of the identifier root.

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              2166. 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/cda/stds/core/StructureDefinition/II
              2168. ClinicalDocument.documentationOf.serviceEvent.classCode
              Control0..1
              BindingThe codes SHALL be taken from CDAActClass
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Default ValueACT
              2170. ClinicalDocument.documentationOf.serviceEvent.moodCode
              Control0..1
              BindingThe codes SHALL be taken from CDAActMood
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueEVN
              2172. ClinicalDocument.documentationOf.serviceEvent.id
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              2174. ClinicalDocument.documentationOf.serviceEvent.code
              Definition

              Drawn from concept domain ActCode

              ShortThe code should be selected from a value set established by the document-level template for a specific type of Patient Generated Document.
              Comments

              This serviceEvent SHOULD contain zero or one [0..1] code (CONF:1198-28712).

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              2176. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
              Definition

              A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

              ShortBase for all types and resources
              Comments

              This serviceEvent SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:4537-14837).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
              Is Modifierfalse
              Invariantsivl-ts-center: Center cannot co-exist with low or high (center.empty() or (low.empty() and high.empty()))
              ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. (value.exists() implies value.toString().length() >= 10)
              ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component. (value.exists() implies value.toString().length() > 10)
              2178. 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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2180. 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.

              ShortEither @value or low/high should be present, but not both
              Control0..1
              TypedateTime(ts: Point in Time)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
              XML FormatIn the XML format, this property is represented as an attribute.
              2182. 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
              BindingThe codes SHALL be taken from CDASetOperator
              (required to http://hl7.org/cda/stds/core/ValueSet/CDASetOperator)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Default ValueI
              2184. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low
              Definition

              This is the low limit of the interval.

              Short**MAY** be precise to at least the second
              Comments

              This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-14838).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
              LabelLow Boundary
              Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
              ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
              2186. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.nullFlavor
              Definition

              If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2188. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.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(ts: Point in Time)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
              XML FormatIn the XML format, this property is represented as an attribute.
              2190. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Default Valuetrue
              2192. 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/cda/stds/core/StructureDefinition/TS
              LabelCentral Value
              2194. 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/cda/stds/core/StructureDefinition/PQ
              LabelWidth
              2196. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
              Definition

              This is the high limit of the interval.

              Short**MAY** be precise to at least the second
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
              LabelHigh Boundary
              Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
              ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
              2198. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.nullFlavor
              Definition

              If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2200. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.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(ts: Point in Time)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
              XML FormatIn the XML format, this property is represented as an attribute.
              2202. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Default Valuetrue
              2204. ClinicalDocument.documentationOf.serviceEvent.performer
              ShortThe performer participant represents clinicians who actually and principally carry out the serviceEvent. In a transfer of care this represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient's key healthcare care team members would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors.
              Comments

              This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:1198-28713).

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer1
              2206. 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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2208. 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/cda/stds/core/StructureDefinition/CS
              2210. 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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              2212. ClinicalDocument.documentationOf.serviceEvent.performer.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2214. ClinicalDocument.documentationOf.serviceEvent.performer.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              2216. ClinicalDocument.documentationOf.serviceEvent.performer.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              2218. ClinicalDocument.documentationOf.serviceEvent.performer.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              2220. ClinicalDocument.documentationOf.serviceEvent.performer.typeId.extension
              Definition

              A character string as a unique identifier within the scope of the identifier root.

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              2222. 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/cda/stds/core/StructureDefinition/II
              2224. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode
              Comments

              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:4537-14840).

              Control1..1
              BindingThe codes SHALL be taken from x_ServiceEventPerformer .
              (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19601)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              2226. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode
              ShortWhen indicating the performer was the primary care physician, implementers should indicate "PCP" as the functionCode
              Comments

              The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:4537-16818).

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              Invariantsshould-code-attr: SHOULD contain @code (code.exists())
              2228. 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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2230. 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.

              Comments

              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:4537-32889).

              Control0..1
              BindingThe codes SHALL be taken from ParticipationFunction .
              (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.10267)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode
              2232. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystem
              Definition

              Specifies the code system that defines the code.

              Control0..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System
              2234. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemName
              Definition

              The common name of the coding system.

              Control0..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System Name
              2236. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemVersion
              Definition

              If applicable, a version descriptor defined specifically for the given code system.

              Control0..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System Version
              2238. 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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplay Name
              2240. 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(oid: ISO Object Identifier)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn 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 namevalueSet.
              2242. 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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn 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 namevalueSetVersion.
              2244. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.originalText
              Definition

              The text or phrase used as the basis for the coding.

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
              LabelOriginal Text
              2246. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.qualifier
              Definition

              Specifies additional codes that increase the specificity of the the primary code.

              Control0..0
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
              LabelQualifier
              2248. 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/cda/stds/core/StructureDefinition/CD
              XML FormatThe type of this property is determined using the xsi:typeattribute.
              LabelTranslation
              2250. ClinicalDocument.documentationOf.serviceEvent.performer.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.

              ShortBase for all types and resources
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
              Is Modifierfalse
              Invariantsivl-ts-center: Center cannot co-exist with low or high (center.empty() or (low.empty() and high.empty()))
              ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. (value.exists() implies value.toString().length() >= 10)
              ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component. (value.exists() implies value.toString().length() > 10)
              2252. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
              Comments

              The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28715).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
              Invariantsshould-us-code: SHOULD contain code (code.exists())
              2254. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.nullFlavor
              Definition

              If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2256. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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/cda/stds/core/StructureDefinition/CS
              2258. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              2260. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2262. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              2264. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              2266. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              2268. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.extension
              Definition

              A character string as a unique identifier within the scope of the identifier root.

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              2270. 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/cda/stds/core/StructureDefinition/II
              2272. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode
              Control0..1
              BindingThe codes SHALL be taken from RoleClassAssignedEntity
              (required to http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueASSIGNED
              2274. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
              ShortThe combined @root and @extension attributes record the performer's identity in a secure, trusted, and unique way.
              Comments

              This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28716).

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              2276. 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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2278. 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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              2280. 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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              2282. 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.

              Comments

              Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-14847).

              Control0..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Invariantsshould-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6')
              2284. 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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              2286. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
              2288. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code
              ShortIf the assignedEntity is an individual, the code SHOULD be selected from value set PersonalandLegalRelationshipRoleType value set
              Comments

              This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28718).

              Control0..1
              BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type .
              (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1)
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              2290. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
              2292. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
              2294. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
              2296. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
              2298. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcPatient
              Control0..1
              Typehttp://hl7.org/fhir/StructureDefinition/Base
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namepatient.
              2300. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcPatient.id
              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
              2302. ClinicalDocument.relatedDocument
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument
              2304. ClinicalDocument.authorization
              ShortThe authorization element represents information about the patient's consent. The type of consent is conveyed in consent/code. Consents in the header have been finalized (consent/statusCode must equal Completed) and should be on file. This specification does not address how 'Privacy Consent' is represented, but does not preclude the inclusion of 'Privacy Consent'. The authorization consent is used for referring to consents that are documented elsewhere in the EHR or medical record for a health condition and/or treatment that is described in the CDA document.
              Comments

              MAY contain zero or more [0..*] authorization (CONF:4537-16792) such that it

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authorization
              2306. ClinicalDocument.authorization.nullFlavor
              Definition

              If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2308. ClinicalDocument.authorization.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/cda/stds/core/StructureDefinition/CS
              2310. ClinicalDocument.authorization.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              2312. ClinicalDocument.authorization.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2314. ClinicalDocument.authorization.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              2316. ClinicalDocument.authorization.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              2318. ClinicalDocument.authorization.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              2320. ClinicalDocument.authorization.typeId.extension
              Definition

              A character string as a unique identifier within the scope of the identifier root.

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              2322. ClinicalDocument.authorization.templateId
              Definition

              When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              2324. ClinicalDocument.authorization.typeCode
              Control0..1
              BindingThe codes SHALL be taken from ActRelationshipAuthorizedBy
              (required to http://terminology.hl7.org/ValueSet/v3-ActRelationshipAuthorizedBy)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueAUTH
              2326. ClinicalDocument.authorization.consent
              Comments

              SHALL contain exactly one [1..1] consent (CONF:4537-16793).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Consent
              2328. ClinicalDocument.authorization.consent.nullFlavor
              Definition

              If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2330. ClinicalDocument.authorization.consent.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/cda/stds/core/StructureDefinition/CS
              2332. ClinicalDocument.authorization.consent.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              2334. ClinicalDocument.authorization.consent.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2336. ClinicalDocument.authorization.consent.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              2338. ClinicalDocument.authorization.consent.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              2340. ClinicalDocument.authorization.consent.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              2342. ClinicalDocument.authorization.consent.typeId.extension
              Definition

              A character string as a unique identifier within the scope of the identifier root.

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              2344. ClinicalDocument.authorization.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/cda/stds/core/StructureDefinition/II
              2346. ClinicalDocument.authorization.consent.classCode
              Control0..1
              BindingThe codes SHALL be taken from CDAActClass
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueCONS
              2348. ClinicalDocument.authorization.consent.moodCode
              Control0..1
              BindingThe codes SHALL be taken from CDAActMood
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueEVN
              2350. ClinicalDocument.authorization.consent.id
              Comments

              This consent MAY contain zero or more [0..*] id (CONF:4537-16794).

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              2352. ClinicalDocument.authorization.consent.code
              ShortThe type of consent (e.g., a consent to perform the related serviceEvent) is conveyed in consent/code.
              Comments

              This consent MAY contain zero or one [0..1] code (CONF:4537-16795).

              Control0..1
              BindingFor example codes, see v3 Code System ActCode
              (example to http://terminology.hl7.org/ValueSet/v3-ActCode)
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              2354. ClinicalDocument.authorization.consent.statusCode
              Comments

              This consent SHALL contain exactly one [1..1] statusCode (CONF:4537-16797).

              Control1..1
              BindingThe codes SHALL be taken from ActStatus
              (required to http://terminology.hl7.org/ValueSet/v3-ActStatus)
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
              2356. ClinicalDocument.authorization.consent.statusCode.nullFlavor
              Definition

              If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2358. ClinicalDocument.authorization.consent.statusCode.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.

              Comments

              This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:4537-16798).

              Control1..1
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode
              Fixed Valuecompleted
              2360. ClinicalDocument.authorization.consent.statusCode.codeSystem
              Definition

              Specifies the code system that defines the code.

              Control0..0
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System
              2362. ClinicalDocument.authorization.consent.statusCode.codeSystemName
              Definition

              The common name of the coding system.

              Control0..0
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System Name
              2364. ClinicalDocument.authorization.consent.statusCode.codeSystemVersion
              Definition

              If applicable, a version descriptor defined specifically for the given code system.

              Control0..0
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelCode System Version
              2366. ClinicalDocument.authorization.consent.statusCode.displayName
              Definition

              A name or title for the code, under which the sending system shows the code value to its users.

              Control0..0
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplay Name
              2368. ClinicalDocument.authorization.consent.statusCode.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(oid: ISO Object Identifier)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn 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 namevalueSet.
              2370. ClinicalDocument.authorization.consent.statusCode.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn 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 namevalueSetVersion.
              2372. ClinicalDocument.authorization.consent.statusCode.originalText
              Definition

              The text or phrase used as the basis for the coding.

              Control0..0
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
              LabelOriginal Text
              2374. ClinicalDocument.authorization.consent.statusCode.qualifier
              Definition

              Specifies additional codes that increase the specificity of the the primary code.

              Control0..0
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
              LabelQualifier
              2376. ClinicalDocument.authorization.consent.statusCode.translation
              Definition

              A set of other concept descriptors that translate this concept descriptor into other code systems.

              Control0..0
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
              XML FormatThe type of this property is determined using the xsi:typeattribute.
              LabelTranslation
              2378. ClinicalDocument.componentOf
              ShortThe encompassing encounter represents the setting of the clinical encounter during which the document act(s) or ServiceEvent(s) occurred. In order to represent providers associated with a specific encounter, they are recorded within the encompassingEncounter as participants. In a CCD, the encompassingEncounter may be used when documenting a specific encounter and its participants. All relevant encounters in a CCD may be listed in the encounters section.
              Comments

              MAY contain zero or one [0..1] componentOf (CONF:4537-9955).

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ComponentOf
              2380. 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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2382. 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/cda/stds/core/StructureDefinition/CS
              2384. 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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              2386. ClinicalDocument.componentOf.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2388. ClinicalDocument.componentOf.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              2390. ClinicalDocument.componentOf.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              2392. ClinicalDocument.componentOf.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              2394. ClinicalDocument.componentOf.typeId.extension
              Definition

              A character string as a unique identifier within the scope of the identifier root.

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              2396. 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/cda/stds/core/StructureDefinition/II
              2398. ClinicalDocument.componentOf.typeCode
              Control0..1
              BindingThe codes SHALL be taken from ActRelationshipHasComponent
              (required to http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueCOMP
              2400. ClinicalDocument.componentOf.encompassingEncounter
              Comments

              The componentOf, if present, SHALL contain exactly one [1..1] encompassingEncounter (CONF:4537-9956).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EncompassingEncounter
              Invariantsshould-responsibleParty: SHOULD contain responsibleParty (responsibleParty.exists())
              2402. ClinicalDocument.componentOf.encompassingEncounter.nullFlavor
              Definition

              If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2404. ClinicalDocument.componentOf.encompassingEncounter.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/cda/stds/core/StructureDefinition/CS
              2406. ClinicalDocument.componentOf.encompassingEncounter.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              2408. ClinicalDocument.componentOf.encompassingEncounter.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2410. ClinicalDocument.componentOf.encompassingEncounter.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              2412. ClinicalDocument.componentOf.encompassingEncounter.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              2414. ClinicalDocument.componentOf.encompassingEncounter.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              2416. ClinicalDocument.componentOf.encompassingEncounter.typeId.extension
              Definition

              A character string as a unique identifier within the scope of the identifier root.

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              2418. 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/cda/stds/core/StructureDefinition/II
              2420. ClinicalDocument.componentOf.encompassingEncounter.classCode
              Control0..1
              BindingThe codes SHALL be taken from CDAActClass
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueENC
              2422. ClinicalDocument.componentOf.encompassingEncounter.moodCode
              Control0..1
              BindingThe codes SHALL be taken from CDAActMood
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueEVN
              2424. ClinicalDocument.componentOf.encompassingEncounter.id
              Comments

              This encompassingEncounter SHALL contain at least one [1..*] id (CONF:4537-9959).

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              2426. ClinicalDocument.componentOf.encompassingEncounter.code
              Comments

              This encompassingEncounter MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Act Encounter Codes urn:oid:2.16.840.1.113762.1.4.1240.5 (CONF:1198-30873).

              Control0..1
              BindingThe codes SHOULD be taken from Act Encounter Codes .
              (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1240.5)
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              2428. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime
              Definition

              A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

              ShortBase for all types and resources
              Comments

              This encompassingEncounter SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:4537-9958).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
              Is Modifierfalse
              Invariantsivl-ts-center: Center cannot co-exist with low or high (center.empty() or (low.empty() and high.empty()))
              ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. (value.exists() implies value.toString().length() >= 10)
              ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component. (value.exists() implies value.toString().length() > 10)
              2430. ClinicalDocument.componentOf.encompassingEncounter.sdtcAdmissionReferralSourceCode
              Definition

              This element is a coded concept that represents the type of referral. Its RIM source class is PatientEncounter.

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameadmissionReferralSourceCode.
              2432. ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode
              Control0..1
              BindingFor example codes, see USEncounterDischargeDisposition
              (example to http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition)
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
              2434. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty
              Definition

              The responsibleParty participant represents the participant having primary legal responsibility for the encounter. This differs from the legalAuthenticator participant in that the legalAuthenticator may or may not be the responsible party, and is serving a medical records function by signing off on the document, moving it into a completed state.

              Comments

              This encompassingEncounter SHOULD contain zero or one [0..1] responsibleParty (CONF:1198-8391).

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
              2436. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.nullFlavor
              Definition

              If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2438. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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/cda/stds/core/StructureDefinition/CS
              2440. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              2442. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2444. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              2446. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              2448. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              2450. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.extension
              Definition

              A character string as a unique identifier within the scope of the identifier root.

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              2452. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.templateId
              Definition

              When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              2454. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCode
              Control0..1
              BindingThe codes SHALL be taken from CDAParticipationType
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueRESP
              2456. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity
              Comments

              The responsibleParty, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-32904).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
              Invariants1198-32905: This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). (assignedPerson.exists() or representedOrganization.exists())
              2458. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant
              2460. ClinicalDocument.componentOf.encompassingEncounter.location
              Definition

              The location participant (location class) relates a healthcare facility (HealthCareFacility class) to the encounter to indicate where the encounter took place. The entity playing the role of HealthCareFacility is a place (Place class). The entity scoping the HealthCareFacility role is an organization (Organization class).

              The setting of an encounter (e.g. cardiology clinic, primary care clinic, rehabilitation hospital, skilled nursing facility) can be expressed in HealthCareFacility.code. Note that setting and physical location are not the same. There is a many-to-many relationship between setting and the physical location where care is delivered. Thus, a particular room can provide the location for cardiology clinic one day, and for primary care clinic another day; and cardiology clinic today might be held in one physical location, but in another physical location tomorrow.

              When the location is an organization, this is indicated by the presence of a scoping Organization, without a playing Place.

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
              2462. ClinicalDocument.componentOf.encompassingEncounter.location.nullFlavor
              Definition

              If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2464. ClinicalDocument.componentOf.encompassingEncounter.location.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/cda/stds/core/StructureDefinition/CS
              2466. ClinicalDocument.componentOf.encompassingEncounter.location.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/cda/stds/core/StructureDefinition/II
              InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
              2468. ClinicalDocument.componentOf.encompassingEncounter.location.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 CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              2470. ClinicalDocument.componentOf.encompassingEncounter.location.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(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              2472. ClinicalDocument.componentOf.encompassingEncounter.location.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(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              2474. ClinicalDocument.componentOf.encompassingEncounter.location.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              2476. ClinicalDocument.componentOf.encompassingEncounter.location.typeId.extension
              Definition

              A character string as a unique identifier within the scope of the identifier root.

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              2478. ClinicalDocument.componentOf.encompassingEncounter.location.templateId
              Definition

              When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              2480. ClinicalDocument.componentOf.encompassingEncounter.location.typeCode
              Control0..1
              BindingThe codes SHALL be taken from ParticipationTargetLocation
              (required to http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueLOC
              2482. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility
              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility
              2484. ClinicalDocument.component
              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Component