Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

## Logical Model: USRealmHeaderforPatientGeneratedDocument - Detailed Descriptions

Active as of 2023-09-29

Definitions for the USRealmHeaderforPatientGeneratedDocument logical model.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

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

0. ClinicalDocument
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. ClinicalDocument.templateId
Control | 2..?
4. ClinicalDocument.templateId:secondary
Slice Name | secondary
Comments | SHALL contain exactly one [1..1] templateId (CONF:1198-28458) such that it
Control | 1..1
6. ClinicalDocument.templateId:secondary.root
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.29.1" (CONF:1198-28459).
Control | 1..?
Pattern Value | 2.16.840.1.113883.10.20.29.1
8. ClinicalDocument.templateId:secondary.extension
Comments | SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32917).
Control | 1..?
Pattern Value | 2015-08-01
10. ClinicalDocument.recordTarget
Short | The 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).
Control | 0..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).
18. ClinicalDocument.recordTarget.patientRole.patient.guardian
Comments | This patient MAY contain zero or more [0..*] guardian (CONF:1198-28469).
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 (CONF:1198-28474).
26. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd
Short | Indicates 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).
28. ClinicalDocument.recordTarget.patientRole.providerOrganization
Short | If present, this organization represents the provider organization where the person is claiming to be a patient. undefined
Comments | This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:1198-28476).
Label | If present, this organization represents the provider organization where the person is claiming to be a patient.
30. ClinicalDocument.author
Short | The 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).
32. ClinicalDocument.author.assignedAuthor
Comments | Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:1198-28478).
34. ClinicalDocument.author.assignedAuthor.id
Comments | This assignedAuthor SHALL contain at least one [1..*] id (CONF:1198-28479).
36. ClinicalDocument.author.assignedAuthor.code
Short | When 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).
38. ClinicalDocument.author.assignedAuthor.code.code
Comments | The code, if present, SHALL contain exactly one [1..1] @code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28676).
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
40. ClinicalDocument.dataEnterer
Short | The 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).
42. ClinicalDocument.dataEnterer.assignedEntity
Comments | The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28679).
44. 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).
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
46. ClinicalDocument.informant
Short | The informant element describes the source of the information in a medical document. Assigned health care providers may be a source of information when a document is created. (e.g., a nurse's aide who provides information about a recent significant health care event that occurred within an acute care facility.) In these cases, the assignedEntity element is used. When the informant is a personal relation, that informant is represented in the relatedEntity element, even if the personal relation is a medical professional. The code element of the relatedEntity describes the relationship between the informant and the patient. The relationship between the informant and the patient needs to be described to help the receiver of the clinical document understand the information in the document. Each informant can be either an assignedEntity (a clinician serving the patient) OR a relatedEntity (a person with a personal or legal relationship with the patient). The constraints here apply to relatedEntity.
48. ClinicalDocument.informant:informant1
Slice Name | informant1
Comments | MAY contain zero or more [0..*] informant (CONF:1198-28681) such that it
50. ClinicalDocument.informant:informant1.relatedEntity
Comments | SHALL contain exactly one [1..1] relatedEntity (CONF:1198-28682).
Control | 1..?
52. ClinicalDocument.informant:informant1.relatedEntity.code
Comments | This relatedEntity MAY contain zero or one [0..1] code (CONF:1198-28683).
54. ClinicalDocument.informant:informant1.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).
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
56. ClinicalDocument.custodian
Short | The 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
Short | The 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
Short | The 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
Short | The 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).
68. ClinicalDocument.informationRecipient.intendedRecipient.id
Short | The 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).
70. ClinicalDocument.informationRecipient.intendedRecipient.id.root
Short | For 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
Short | In 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
Short | The 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).
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
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).
86. ClinicalDocument.authenticator.assignedEntity.id
Short | The 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).
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
90. ClinicalDocument.participant
Short | The 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
Short | Unless 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).
Control | 1..?
94. ClinicalDocument.participant.associatedEntity
Comments | The participant, if present, SHALL contain exactly one [1..1] associatedEntity (CONF:1198-28705).
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).
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
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
Short | A 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).
108. ClinicalDocument.documentationOf.serviceEvent.code
Short | The 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
Short | The functionCode SHALL be selected from value set ParticipationType 2.16.840.1.113883.1.11.10901 When indicating the performer was the primary care physician the functionCode shall be ='PCP'
Comments | The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:1198-28714).
114. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Comments | The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28715).
116. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
Short | The 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).
118. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code
Short | If 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).
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type

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

0. ClinicalDocument
Definition | Base definition for all types defined in FHIR type system.
Short | Base for all types and resources
Control | 10..1*
Is Modifier | false
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
4. 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.
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | US
6. ClinicalDocument.realmCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
8. ClinicalDocument.realmCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
10. ClinicalDocument.realmCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
12. ClinicalDocument.realmCode.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
14. ClinicalDocument.realmCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
16. ClinicalDocument.realmCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
18. ClinicalDocument.realmCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
20. ClinicalDocument.typeId
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Comments | SHALL contain exactly one [1..1] typeId (CONF:4537-5361).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
22. ClinicalDocument.typeId.root
Comments | This typeId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.1.3" (CONF:4537-5250).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | 2.16.840.1.113883.1.3
24. ClinicalDocument.typeId.extension
Definition | An Extension
Short | Extension
Comments | This typeId SHALL contain exactly one [1..1] @extension="POCD_HD000040" (CONF:4537-5251).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | POCD_HD000040
26. 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
Control | 2..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This element introduces a set of slices on `ClinicalDocument.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ root value @ extension
28. ClinicalDocument.templateId:us-realm
Slice Name | us-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
Short | templateId
Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-5252) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
30. 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.
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.1" (CONF:4537-10036).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.10.20.22.1.1
32. ClinicalDocument.templateId:us-realm.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Comments | SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-32503).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | 2023-05-01
34. ClinicalDocument.templateId:secondary
Slice Name | secondary
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Comments | SHALL contain exactly one [1..1] templateId (CONF:1198-28458) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
36. ClinicalDocument.templateId:secondary.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.29.1" (CONF:1198-28459).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.10.20.29.1
38. ClinicalDocument.templateId:secondary.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Comments | SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32917).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | 2015-08-01
40. ClinicalDocument.id
Comments | SHALL contain exactly one [1..1] id (CONF:4537-5363).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | 4537-9991: This id **SHALL** be a globally unique identifier for the document (CONF:4537-9991). ()
42. ClinicalDocument.code
Comments | SHALL contain exactly one [1..1] code (CONF:4537-5253).
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from FHIRDocumentTypeCodes
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
Invariants | 4537-9992: This code **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992). () 4537-32948: This code **SHALL** be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:4537-32948). ()
44. ClinicalDocument.title
Short | The 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ST
46. 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.
Short | Base for all types and resources
Comments | SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5256).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-10127: **SHALL** be precise to the day (CONF:81-10127). () 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). () 81-10129: **MAY** be precise to the second (CONF:81-10129). () 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
48. ClinicalDocument.confidentialityCode
Comments | SHALL contain exactly one [1..1] confidentialityCode, which SHOULD be selected from ValueSet HL7 BasicConfidentialityKind urn:oid:2.16.840.1.113883.1.11.16926 DYNAMIC (CONF:4537-5259).
Control | 1..1
Binding | The codes SHOULD be taken from HL7 BasicConfidentialityKind
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
50. ClinicalDocument.languageCode
Comments | SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:4537-5372).
Control | 1..1
Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
52. ClinicalDocument.recordTarget
Short | The 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
54. ClinicalDocument.recordTarget.patientRole
Comments | This recordTarget SHALL contain exactly one [1..1] patientRole (CONF:1198-28461).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PatientRole
56. ClinicalDocument.recordTarget.patientRole.id
Comments | This patientRole SHALL contain at least one [1..*] id (CONF:1198-28462).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
58. 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 | Base for all types and resources
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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
60. ClinicalDocument.recordTarget.patientRole.telecom
Comments | This patientRole SHALL contain at least one [1..*] telecom (CONF:4537-5280).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
62. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
64. ClinicalDocument.recordTarget.patientRole.patient
Comments | This patientRole SHALL contain exactly one [1..1] patient (CONF:1198-28465).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Patient
66. 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.
Short | Base 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.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName(US Realm Patient Name (PTN.US.FIELDED))
Is Modifier | false
Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). ()
68. 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).
Control | 1..1
Binding | The codes SHALL be taken from Administrative Gender (HL7 V3)
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
70. ClinicalDocument.recordTarget.patientRole.patient.birthTime
Comments | This patient SHALL contain exactly one [1..1] birthTime (CONF:4537-5298).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Invariants | 4537-5299: **SHALL** be precise to year (CONF:4537-5299). () 4537-5300: **SHOULD** be precise to day (CONF:4537-5300). () 4537-32418: **MAY** be precise to the minute (CONF:4537-32418). ()
72. ClinicalDocument.recordTarget.patientRole.patient.raceCode
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).
Control | 1..1
Binding | The codes SHALL be taken from Race Category Excluding Nulls
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
74. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode
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).
Control | 1..1
Binding | The codes SHALL be taken from Ethnicity
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
76. ClinicalDocument.recordTarget.patientRole.patient.guardian
Comments | This patient MAY contain zero or more [0..*] guardian (CONF:1198-28469).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Guardian
78. ClinicalDocument.recordTarget.patientRole.patient.guardian.id
Comments | The guardian, if present, SHOULD contain zero or more [0..*] id (CONF:1198-28470).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
80. 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).
Control | 0..1
Binding | The codes SHALL be taken from Personal And Legal Relationship Role Type
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
82. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson
Comments | The guardian, if present, SHALL contain exactly one [1..1] guardianPerson (CONF:4537-5385).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
84. 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.
Short | Base 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.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
86. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication
Comments | This patient SHOULD contain zero or more [0..*] languageCommunication (CONF:1198-28474).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication
88. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode
Comments | The languageCommunication, if present, SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:4537-5407).
Control | 1..1
Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
90. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd
Short | Indicates 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).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
92. ClinicalDocument.recordTarget.patientRole.providerOrganization
Short | If present, this organization represents the provider organization where the person is claiming to be a patient. undefined
Comments | This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:1198-28476).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
Label | If present, this organization represents the provider organization where the person is claiming to be a patient.
94. 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.
Short | Logical 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.
Control | 10..*1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II id
Is Modifier | false
96. ClinicalDocument.recordTarget.patientRole.providerOrganization.name
Definition | A name associated with the organization.
Short | Name 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.
Control | 10..*1 This element is affected by the following invariants: org-1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ON string
Is Modifier | false
Requirements | Need to use the name as the label of the organization.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] telecom (CONF:4537-5420).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
100. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
102. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
104. ClinicalDocument.author
Short | The 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author
106. 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.
Short | Base for all types and resources
Comments | Such authors SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5445).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-10127: **SHALL** be precise to the day (CONF:81-10127). () 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). () 81-10129: **MAY** be precise to the second (CONF:81-10129). () 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
108. ClinicalDocument.author.assignedAuthor
Comments | Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:1198-28478).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor
Invariants | 4537-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). ()
110. ClinicalDocument.author.assignedAuthor.id
Comments | This assignedAuthor SHALL contain at least one [1..*] id (CONF:1198-28479).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This element introduces a set of slices on `ClinicalDocument.author.assignedAuthor.id`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ root
112. ClinicalDocument.author.assignedAuthor.id:id1
Slice Name | id1
Short | id
Comments | This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:4537-32882) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
114. ClinicalDocument.author.assignedAuthor.id:id1.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-32884).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
116. ClinicalDocument.author.assignedAuthor.code
Short | When 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).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System RoleCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
118. 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.
Comments | The code, if present, SHALL contain exactly one [1..1] @code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28676).
Control | 1..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
120. ClinicalDocument.author.assignedAuthor.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
122. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
124. ClinicalDocument.author.assignedAuthor.telecom
Comments | This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:4537-5428).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
126. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
128. ClinicalDocument.dataEnterer
Short | The 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).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/DataEnterer
130. ClinicalDocument.dataEnterer.time
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
132. ClinicalDocument.dataEnterer.assignedEntity
Comments | The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28679).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
134. ClinicalDocument.dataEnterer.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5443).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
136. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
138. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
140. ClinicalDocument.dataEnterer.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5466).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
142. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
144. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5469).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
146. 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.
Short | Base 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.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
148. ClinicalDocument.informant
Short | The informant element describes the source of the information in a medical document. Assigned health care providers may be a source of information when a document is created. (e.g., a nurse's aide who provides information about a recent significant health care event that occurred within an acute care facility.) In these cases, the assignedEntity element is used. When the informant is a personal relation, that informant is represented in the relatedEntity element, even if the personal relation is a medical professional. The code element of the relatedEntity describes the relationship between the informant and the patient. The relationship between the informant and the patient needs to be described to help the receiver of the clinical document understand the information in the document. Each informant can be either an assignedEntity (a clinician serving the patient) OR a relatedEntity (a person with a personal or legal relationship with the patient). The constraints here apply to relatedEntity.
Comments | MAY contain zero or more [0..*] informant (CONF:4537-31355) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
Slicing | This element introduces a set of slices on `ClinicalDocument.informant`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ relatedEntity
150. ClinicalDocument.informant:informant1
Slice Name | informant1
Short | informant
Comments | MAY contain zero or more [0..*] informant (CONF:1198-28681) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
152. ClinicalDocument.informant:informant1.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8002).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
154. ClinicalDocument.informant:informant1.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-9945).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | 4537-9946: If assignedEntity/id is a provider then this id, **SHOULD** include zero or one [0..1] id where id/@root ="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-9946). ()
156. ClinicalDocument.informant:informant1.assignedEntity.addr
Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
158. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-8221).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
160. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name
Definition | A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status). A name associated with the person.
Short | Base 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.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
162. ClinicalDocument.informant:informant1.relatedEntity
Comments | SHALL contain exactly one [1..1] relatedEntity (CONF:1198-28682).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
164. ClinicalDocument.informant:informant1.relatedEntity.classCode
Control | 1..1
Binding | The codes SHALL be taken from RoleClassMutualRelationship
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
166. ClinicalDocument.informant:informant1.relatedEntity.code
Comments | This relatedEntity MAY contain zero or one [0..1] code (CONF:1198-28683).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from PersonalRelationshipRoleType
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
168. ClinicalDocument.informant:informant1.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).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
170. ClinicalDocument.informant:informant1.relatedEntity.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
172. ClinicalDocument.informant:informant2
Slice Name | informant2
Short | informant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
174. ClinicalDocument.informant:informant2.relatedEntity
Comments | SHALL contain exactly one [1..1] relatedEntity (CONF:4537-31356).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
176. ClinicalDocument.custodian
Short | The 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Custodian
178. ClinicalDocument.custodian.assignedCustodian
Comments | This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:1198-28686).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedCustodian
180. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
Short | The 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CustodianOrganization
182. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
Short | The 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
184. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name
Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:4537-5524).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ON
186. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom
Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:4537-5525).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
188. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
190. 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.
Short | Base 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
192. ClinicalDocument.informationRecipient
Short | The 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).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient
194. ClinicalDocument.informationRecipient.intendedRecipient
Comments | The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:1198-28691).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IntendedRecipient
196. ClinicalDocument.informationRecipient.intendedRecipient.classCode
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | ASSIGNED
198. ClinicalDocument.informationRecipient.intendedRecipient.id
Short | The 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).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
200. 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.
Short | For 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
202. ClinicalDocument.legalAuthenticator
Short | In 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).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator
204. 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.
Short | Base for all types and resources
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5580).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-10127: **SHALL** be precise to the day (CONF:81-10127). () 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). () 81-10129: **MAY** be precise to the second (CONF:81-10129). () 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
206. ClinicalDocument.legalAuthenticator.signatureCode
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:4537-5583).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
208. 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).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | S
210. ClinicalDocument.legalAuthenticator.signatureCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
212. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
214. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
216. ClinicalDocument.legalAuthenticator.signatureCode.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
218. ClinicalDocument.legalAuthenticator.signatureCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
220. ClinicalDocument.legalAuthenticator.signatureCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
222. ClinicalDocument.legalAuthenticator.signatureCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
224. ClinicalDocument.legalAuthenticator.assignedEntity
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28695).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
226. ClinicalDocument.legalAuthenticator.assignedEntity.id
Short | The 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
228. ClinicalDocument.legalAuthenticator.assignedEntity.code
Comments | This assignedEntity MAY contain zero or one [0..1] code (CONF:1198-28697).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
230. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
232. ClinicalDocument.legalAuthenticator.assignedEntity.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
234. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
236. ClinicalDocument.legalAuthenticator.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5595).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
238. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
240. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5597).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
242. 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.
Short | Base 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.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
244. ClinicalDocument.authenticator
Comments | MAY contain zero or more [0..*] authenticator (CONF:1198-28699).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authenticator
Slicing | This element introduces a set of slices on `ClinicalDocument.authenticator`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ ClinicalDocument.signatureCode value @ ClinicalDocument.assignedEntity value @ ClinicalDocument.time
246. ClinicalDocument.authenticator.time
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
248. ClinicalDocument.authenticator.signatureCode
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
250. ClinicalDocument.authenticator.assignedEntity
Comments | The authenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28700).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
252. ClinicalDocument.authenticator.assignedEntity.id
Short | The 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
254. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
256. ClinicalDocument.authenticator:authenticator1
Slice Name | authenticator1
Short | authenticator
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authenticator
258. ClinicalDocument.authenticator:authenticator1.time
Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.
Short | Base for all types and resources
Comments | SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5608).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-10127: **SHALL** be precise to the day (CONF:81-10127). () 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). () 81-10129: **MAY** be precise to the second (CONF:81-10129). () 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
260. ClinicalDocument.authenticator:authenticator1.signatureCode
Comments | SHALL contain exactly one [1..1] signatureCode (CONF:4537-5610).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
262. ClinicalDocument.authenticator:authenticator1.signatureCode.code
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
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).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | S
264. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
266. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
268. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
270. ClinicalDocument.authenticator:authenticator1.signatureCode.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
272. ClinicalDocument.authenticator:authenticator1.signatureCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
274. ClinicalDocument.authenticator:authenticator1.signatureCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
276. ClinicalDocument.authenticator:authenticator1.signatureCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
278. ClinicalDocument.authenticator:authenticator1.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5612).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
280. ClinicalDocument.authenticator:authenticator1.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5613).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
282. ClinicalDocument.authenticator:authenticator1.assignedEntity.addr
Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
284. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5622).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
286. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.use
Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.
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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
288. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5624).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
290. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.name
Definition | A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status). A name associated with the person.
Short | Base 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.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
292. ClinicalDocument.participant
Short | The 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).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant1
Invariants | 4537-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). () 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). ()
294. ClinicalDocument.participant.typeCode
Short | Unless 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).
Control | 1..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
296. ClinicalDocument.participant.associatedEntity
Comments | The participant, if present, SHALL contain exactly one [1..1] associatedEntity (CONF:1198-28705).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
298. ClinicalDocument.participant.associatedEntity.classCode
Control | 1..1
Binding | The codes SHALL be taken from RoleClassAssociative
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
300. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
302. ClinicalDocument.inFulfillmentOf
Comments | MAY contain zero or more [0..*] inFulfillmentOf (CONF:1198-28707).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf
304. ClinicalDocument.inFulfillmentOf.order
Comments | The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:1198-28708).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Order
306. ClinicalDocument.inFulfillmentOf.order.classCode
Control | 1..1
Binding | The codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | ACT
308. ClinicalDocument.inFulfillmentOf.order.id
Short | A 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
310. ClinicalDocument.documentationOf
Comments | MAY contain zero or more [0..*] documentationOf (CONF:1198-28710).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf
312. ClinicalDocument.documentationOf.serviceEvent
Comments | The documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:1198-28711).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent
314. ClinicalDocument.documentationOf.serviceEvent.classCode
Control | 1..1
Binding | The codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | ACT
316. ClinicalDocument.documentationOf.serviceEvent.code
Definition | Drawn from concept domain ActCode
Short | The 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).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
318. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Comments | This serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:4537-14837).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
320. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low
Definition | This is the low limit of the interval.
Comments | This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-14838).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | Low Boundary
322. ClinicalDocument.documentationOf.serviceEvent.performer
Comments | This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:1198-28713).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer1
324. 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).
Control | 1..1
Binding | The codes SHALL be taken from x_ServiceEventPerformer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
326. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode
Short | The functionCode SHALL be selected from value set ParticipationType 2.16.840.1.113883.1.11.10901 When indicating the performer was the primary care physician the functionCode shall be ='PCP'
Comments | The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:1198-28714).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
328. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
330. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Comments | The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28715).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
332. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
Short | The 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
334. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code
Short | If 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).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
336. ClinicalDocument.component
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Component

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

0. ClinicalDocument
Definition | Base definition for all types defined in FHIR type system.
Short | Base for all types and resources
Control | 1..1
Is Modifier | false
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
2. ClinicalDocument.classCode
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DOCCLIN
4. ClinicalDocument.moodCode
Control | 0..1
Binding | The codes SHALL be taken from ActMood
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | EVN
6. 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
8. ClinicalDocument.realmCode.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
10. 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.
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | US
12. ClinicalDocument.realmCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
14. ClinicalDocument.realmCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
16. ClinicalDocument.realmCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
18. ClinicalDocument.realmCode.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
20. 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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
22. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
24. ClinicalDocument.realmCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
26. ClinicalDocument.realmCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
28. ClinicalDocument.realmCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
30. ClinicalDocument.typeId
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Comments | SHALL contain exactly one [1..1] typeId (CONF:4537-5361).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
32. ClinicalDocument.typeId.root
Comments | This typeId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.1.3" (CONF:4537-5250).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | 2.16.840.1.113883.1.3
34. ClinicalDocument.typeId.extension
Definition | An Extension
Short | Extension
Comments | This typeId SHALL contain exactly one [1..1] @extension="POCD_HD000040" (CONF:4537-5251).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | POCD_HD000040
36. 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
Control | 2..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This element introduces a set of slices on `ClinicalDocument.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ root value @ extension
38. ClinicalDocument.templateId:us-realm
Slice Name | us-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
Short | templateId
Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-5252) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
40. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
42. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
44. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
46. 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.
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.1" (CONF:4537-10036).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.10.20.22.1.1
48. ClinicalDocument.templateId:us-realm.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Comments | SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-32503).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | 2023-05-01
50. ClinicalDocument.templateId:secondary
Slice Name | secondary
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Comments | SHALL contain exactly one [1..1] templateId (CONF:1198-28458) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
52. ClinicalDocument.templateId:secondary.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
54. ClinicalDocument.templateId:secondary.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
56. ClinicalDocument.templateId:secondary.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
58. ClinicalDocument.templateId:secondary.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.29.1" (CONF:1198-28459).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.10.20.29.1
60. ClinicalDocument.templateId:secondary.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Comments | SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32917).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | 2015-08-01
62. ClinicalDocument.id
Comments | SHALL contain exactly one [1..1] id (CONF:4537-5363).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | 4537-9991: This id **SHALL** be a globally unique identifier for the document (CONF:4537-9991). ()
64. ClinicalDocument.code
Comments | SHALL contain exactly one [1..1] code (CONF:4537-5253).
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from FHIRDocumentTypeCodes
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
Invariants | 4537-9992: This code **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992). () 4537-32948: This code **SHALL** be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:4537-32948). ()
66. ClinicalDocument.title
Short | The 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ST
68. 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.
Short | Base for all types and resources
Comments | SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5256).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-10127: **SHALL** be precise to the day (CONF:81-10127). () 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). () 81-10129: **MAY** be precise to the second (CONF:81-10129). () 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
70. ClinicalDocument.confidentialityCode
Comments | SHALL contain exactly one [1..1] confidentialityCode, which SHOULD be selected from ValueSet HL7 BasicConfidentialityKind urn:oid:2.16.840.1.113883.1.11.16926 DYNAMIC (CONF:4537-5259).
Control | 1..1
Binding | The codes SHOULD be taken from HL7 BasicConfidentialityKind
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
72. ClinicalDocument.languageCode
Comments | SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:4537-5372).
Control | 1..1
Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
74. ClinicalDocument.setId
Comments | MAY contain zero or one [0..1] setId (CONF:4537-5261).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | 4537-6380: If setId is present versionNumber **SHALL** be present (CONF:4537-6380). ()
76. ClinicalDocument.versionNumber
Comments | MAY contain zero or one [0..1] versionNumber (CONF:4537-5264).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
Invariants | 4537-6387: If versionNumber is present setId **SHALL** be present (CONF:4537-6387). ()
78. ClinicalDocument.copyTime
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
80. ClinicalDocument.recordTarget
Short | The 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
82. ClinicalDocument.recordTarget.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
84. ClinicalDocument.recordTarget.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | RCT
86. ClinicalDocument.recordTarget.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
88. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
90. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
92. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
94. ClinicalDocument.recordTarget.patientRole
Comments | This recordTarget SHALL contain exactly one [1..1] patientRole (CONF:1198-28461).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PatientRole
96. ClinicalDocument.recordTarget.patientRole.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassRelationshipFormal
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PAT
98. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
100. ClinicalDocument.recordTarget.patientRole.id
Comments | This patientRole SHALL contain at least one [1..*] id (CONF:1198-28462).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
102. ClinicalDocument.recordTarget.patientRole.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
104. 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 | Base for all types and resources
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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
106. ClinicalDocument.recordTarget.patientRole.telecom
Comments | This patientRole SHALL contain at least one [1..*] telecom (CONF:4537-5280).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
108. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
110. ClinicalDocument.recordTarget.patientRole.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
112. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
114. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
116. ClinicalDocument.recordTarget.patientRole.patient
Comments | This patientRole SHALL contain exactly one [1..1] patient (CONF:1198-28465).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Patient
118. ClinicalDocument.recordTarget.patientRole.patient.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
120. ClinicalDocument.recordTarget.patientRole.patient.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
122. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
124. ClinicalDocument.recordTarget.patientRole.patient.id
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
126. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Patient Name (PTN.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). ()
128. ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`desc`.
130. 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).
Control | 1..1
Binding | The codes SHALL be taken from Administrative Gender (HL7 V3)
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
132. ClinicalDocument.recordTarget.patientRole.patient.birthTime
Comments | This patient SHALL contain exactly one [1..1] birthTime (CONF:4537-5298).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Invariants | 4537-5299: **SHALL** be precise to year (CONF:4537-5299). () 4537-5300: **SHOULD** be precise to day (CONF:4537-5300). () 4537-32418: **MAY** be precise to the minute (CONF:4537-32418). ()
134. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd
Short | sdtc:deceasedInd
Comments | This patient MAY contain zero or one [0..1] sdtc:deceasedInd (CONF:4537-32990).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`deceasedInd`.
Invariants | 4537-32993: If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present (CONF:4537-32993). ()
136. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime
Short | sdtc:deceasedTime
Comments | This patient MAY contain zero or one [0..1] sdtc:deceasedTime (CONF:4537-32988).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`deceasedTime`.
138. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
140. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime.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.
Comments | The sdtc:deceasedTime, if present, SHOULD contain zero or one [0..1] @value (CONF:4537-32989).
Control | 0..1
Type | string(ts: Point in Time)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML Format | In the XML format, this property is represented as an attribute.
Invariants | 4537-32991: **SHALL** be precise to to the year (CONF:4537-32991). () 4537-32992: **SHOULD** be precise to the day (CONF:4537-32992). ()
142. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`multipleBirthInd`.
144. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT-POS
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`multipleBirthOrderNumber`.
146. 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).
Control | 0..1
Binding | The codes SHALL be taken from Marital Status
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
148. 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).
Control | 0..1
Binding | The codes SHALL be taken from Religious Affiliation
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
150. ClinicalDocument.recordTarget.patientRole.patient.raceCode
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).
Control | 1..1
Binding | The codes SHALL be taken from Race Category Excluding Nulls
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
152. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode
Short | 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).
Control | 0..*
Binding | The codes SHALL be taken from Race Value Set
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`raceCode`.
Invariants | 4537-31347: If sdtc:raceCode is present, then the patient **SHALL** contain [1..1] raceCode (CONF:4537-31347). ()
154. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode
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).
Control | 1..1
Binding | The codes SHALL be taken from Ethnicity
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
156. ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode
Short | ethnicGroupCode
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).
Control | 0..*
Binding | The codes SHALL be taken from Detailed Ethnicity
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`ethnicGroupCode`.
158. ClinicalDocument.recordTarget.patientRole.patient.guardian
Comments | This patient MAY contain zero or more [0..*] guardian (CONF:1198-28469).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Guardian
160. ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAgent
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | GUARD
162. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
164. ClinicalDocument.recordTarget.patientRole.patient.guardian.id
Comments | The guardian, if present, SHOULD contain zero or more [0..*] id (CONF:1198-28470).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
166. ClinicalDocument.recordTarget.patientRole.patient.guardian.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
168. 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).
Control | 0..1
Binding | The codes SHALL be taken from Personal And Legal Relationship Role Type
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
170. 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.
Short | Base 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).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
172. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom
Comments | The guardian, if present, SHOULD contain zero or more [0..*] telecom (CONF:4537-5382).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
174. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
176. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
178. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
180. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
182. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson
Comments | The guardian, if present, SHALL contain exactly one [1..1] guardianPerson (CONF:4537-5385).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
184. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
186. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
188. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
190. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
192. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
194. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
196. ClinicalDocument.recordTarget.patientRole.patient.birthplace
Comments | This patient MAY contain zero or one [0..1] birthplace (CONF:4537-5395).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Birthplace
198. ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassPassive
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | BIRTHPL
200. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
202. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place
Comments | The birthplace, if present, SHALL contain exactly one [1..1] place (CONF:4537-5396).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Place
204. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassPlace
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PLC
206. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
208. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
210. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/EN
212. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr
Comments | This place SHALL contain exactly one [1..1] addr (CONF:4537-5397).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Invariants | 4537-5402: If country is US, this addr **SHALL** contain exactly one [1..1] state, which **SHALL** be selected from ValueSet StateValueSet 2.16.840.1.113883.3.88.12.80.1 *DYNAMIC* (CONF:4537-5402). () 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). ()
214. 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.
Short | Primitive Type code
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Label | Exceptional Value Detail
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) cs-pattern: cs attributes must not contain any whitespace (`matches('^[^\\s]+$')`)
216. 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.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Is Not Ordered
218. 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.
Control | 0..*
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
220. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter
Definition | Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
222. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DEL
224. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country
Definition | Country
Comments | This addr SHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:4537-5404).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
226. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | CNT
228. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state
Definition | A sub-unit of a country with limited sovereignty in a federally organized country.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
230. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | STA
232. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county
Definition | A sub-unit of a state or province. (49 of the United States of America use the term "county;" Louisiana uses the term "parish".)
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
234. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | CPA
236. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city
Definition | The name of the city, town, village, or other community or delivery center
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
238. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | CTY
240. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode
Definition | A postal code designating a region defined by the postal service.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
242. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ZIP
244. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine
Definition | Street address line
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
246. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | SAL
248. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber
Definition | The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
250. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | BNR
252. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric
Definition | The numeric portion of a building number
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
254. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | BNN
256. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction
Definition | Direction (e.g., N, S, W, E)
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
258. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DIR
260. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName
Definition | Name of a roadway or artery recognized by a municipality (including street type and direction)
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
262. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | STR
264. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase
Definition | The base name of a roadway or artery recognized by a municipality (excluding street type and direction)
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
266. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | STB
268. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType
Definition | The designation given to the street. (e.g. Street, Avenue, Crescent, etc.)
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
270. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | STTYP
272. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator
Definition | This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
274. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ADL
276. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID
Definition | The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
278. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | UNID
280. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType
Definition | Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
282. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | UNIT
284. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf
Definition | The name of the party who will take receipt at the specified address, and will take on responsibility for ensuring delivery to the target recipient
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
286. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | CAR
288. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract
Definition | A geographic sub-unit delineated for demographic purposes.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
290. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | CEN
292. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine
Definition | A delivery address line is frequently used instead of breaking out delivery mode, delivery installation, etc. An address generally has only a delivery address line or a street address line, but not both.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
294. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DAL
296. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType
Definition | Indicates the type of delivery installation (the facility to which the mail will be delivered prior to final shipping via the delivery mode.) Example: post office, letter carrier depot, community mail center, station, etc.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
298. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DINST
300. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea
Definition | The location of the delivery installation, usually a town or city, and is only required if the area is different from the municipality. Area to which mail delivery service is provided from any postal facility or service such as an individual letter carrier, rural route, or postal route.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
302. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DINSTA
304. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier
Definition | A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
306. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DINSTQ
308. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode
Definition | Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
310. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DMOD
312. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier
Definition | Represents the routing information such as a letter carrier route number. It is the identifying number of the designator (the box number or rural route number).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
314. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DMODID
316. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix
Definition | Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
318. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | BNS
320. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox
Definition | A numbered box located in a post station.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
322. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | POB
324. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct
Definition | A subsection of a municipality
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
326. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PRE
328. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.other
Definition | Textual representation of (part of) the address
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as unadorned text.
330. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
332. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication
Comments | This patient SHOULD contain zero or more [0..*] languageCommunication (CONF:1198-28474).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication
334. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
336. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode
Comments | The languageCommunication, if present, SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:4537-5407).
Control | 1..1
Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
338. 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).
Control | 0..1
Binding | The codes SHALL be taken from LanguageAbilityMode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
340. 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).
Control | 0..1
Binding | The codes SHALL be taken from LanguageAbilityProficiency
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
342. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd
Short | Indicates 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).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
344. ClinicalDocument.recordTarget.patientRole.providerOrganization
Short | If present, this organization represents the provider organization where the person is claiming to be a patient. undefined
Comments | This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:1198-28476).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
Label | If present, this organization represents the provider organization where the person is claiming to be a patient.
346. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
348. ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ORG
350. ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
352. ClinicalDocument.recordTarget.patientRole.providerOrganization.realmCode
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
354. ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
356. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
358. ClinicalDocument.recordTarget.patientRole.providerOrganization.id
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] id (CONF:4537-5417).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
360. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
362. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
364. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
366. 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
368. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
370. ClinicalDocument.recordTarget.patientRole.providerOrganization.name
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] name (CONF:4537-5419).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ON
372. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] telecom (CONF:4537-5420).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
374. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
376. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
378. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
380. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
382. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
384. ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from OrganizationIndustryClassNAICS
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
386. ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
388. ClinicalDocument.author
Short | The 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author
390. ClinicalDocument.author.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
392. ClinicalDocument.author.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | AUT
394. ClinicalDocument.author.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
396. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
398. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
400. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
402. ClinicalDocument.author.functionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
404. 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.
Short | Base for all types and resources
Comments | Such authors SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5445).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-10127: **SHALL** be precise to the day (CONF:81-10127). () 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). () 81-10129: **MAY** be precise to the second (CONF:81-10129). () 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
406. ClinicalDocument.author.assignedAuthor
Comments | Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:1198-28478).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor
Invariants | 4537-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). ()
408. ClinicalDocument.author.assignedAuthor.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
410. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
412. ClinicalDocument.author.assignedAuthor.id
Comments | This assignedAuthor SHALL contain at least one [1..*] id (CONF:1198-28479).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This element introduces a set of slices on `ClinicalDocument.author.assignedAuthor.id`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ root
414. ClinicalDocument.author.assignedAuthor.id:id1
Slice Name | id1
Short | id
Comments | This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:4537-32882) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
416. ClinicalDocument.author.assignedAuthor.id:id1.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Comments | MAY contain zero or one [0..1] @nullFlavor="UNK" Unknown (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:4537-32883).
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
Fixed Value | UNK
418. ClinicalDocument.author.assignedAuthor.id:id1.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
420. ClinicalDocument.author.assignedAuthor.id:id1.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
422. ClinicalDocument.author.assignedAuthor.id:id1.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-32884).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
424. ClinicalDocument.author.assignedAuthor.id:id1.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).
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
426. ClinicalDocument.author.assignedAuthor.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
428. ClinicalDocument.author.assignedAuthor.code
Short | When 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).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System RoleCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
430. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
432. 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.
Comments | The code, if present, SHALL contain exactly one [1..1] @code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28676).
Control | 1..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
434. ClinicalDocument.author.assignedAuthor.code.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
436. ClinicalDocument.author.assignedAuthor.code.codeSystemName
Definition | The common name of the coding system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
438. ClinicalDocument.author.assignedAuthor.code.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
440. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
442. 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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
444. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
446. ClinicalDocument.author.assignedAuthor.code.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
448. ClinicalDocument.author.assignedAuthor.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
450. ClinicalDocument.author.assignedAuthor.code.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
452. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
454. ClinicalDocument.author.assignedAuthor.telecom
Comments | This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:4537-5428).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
456. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
458. ClinicalDocument.author.assignedAuthor.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
460. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
462. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
464. ClinicalDocument.author.assignedAuthor.assignedPerson
Comments | This assignedAuthor SHOULD contain zero or one [0..1] assignedPerson (CONF:4537-5430).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
466. ClinicalDocument.author.assignedAuthor.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
468. ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
470. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
472. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
474. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
476. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice
Comments | This assignedAuthor SHOULD contain zero or one [0..1] assignedAuthoringDevice (CONF:4537-16783).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice
478. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassDevice
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DEV
480. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
482. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
484. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.code
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from EntityCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
486. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName
Comments | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] manufacturerModelName (CONF:4537-16784).
Control | 1..1
Binding | For example codes, see Manufacturer Model Name Example
Type | http://hl7.org/cda/stds/core/StructureDefinition/SC
488. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName
Comments | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] softwareName (CONF:4537-16785).
Control | 1..1
Binding | For example codes, see Software Name Example
Type | http://hl7.org/cda/stds/core/StructureDefinition/SC
490. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/MaintainedEntity
492. ClinicalDocument.author.assignedAuthor.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
494. ClinicalDocument.dataEnterer
Short | The 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).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/DataEnterer
496. ClinicalDocument.dataEnterer.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
498. ClinicalDocument.dataEnterer.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ENT
500. ClinicalDocument.dataEnterer.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
502. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
504. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
506. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
508. ClinicalDocument.dataEnterer.time
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
510. ClinicalDocument.dataEnterer.assignedEntity
Comments | The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28679).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
512. ClinicalDocument.dataEnterer.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
514. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
516. ClinicalDocument.dataEnterer.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5443).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
518. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
520. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
522. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
524. 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
526. ClinicalDocument.dataEnterer.assignedEntity.id.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
528. ClinicalDocument.dataEnterer.assignedEntity.sdtcIdentifiedBy
Definition | Element AssignedEntity.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
530. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
532. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
534. ClinicalDocument.dataEnterer.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5466).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
536. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
538. ClinicalDocument.dataEnterer.assignedEntity.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
540. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
542. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
544. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5469).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
546. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
548. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
550. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
552. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
554. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
556. ClinicalDocument.dataEnterer.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
558. ClinicalDocument.informant
Short | The informant element describes the source of the information in a medical document. Assigned health care providers may be a source of information when a document is created. (e.g., a nurse's aide who provides information about a recent significant health care event that occurred within an acute care facility.) In these cases, the assignedEntity element is used. When the informant is a personal relation, that informant is represented in the relatedEntity element, even if the personal relation is a medical professional. The code element of the relatedEntity describes the relationship between the informant and the patient. The relationship between the informant and the patient needs to be described to help the receiver of the clinical document understand the information in the document. Each informant can be either an assignedEntity (a clinician serving the patient) OR a relatedEntity (a person with a personal or legal relationship with the patient). The constraints here apply to relatedEntity.
Comments | MAY contain zero or more [0..*] informant (CONF:4537-31355) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
Slicing | This element introduces a set of slices on `ClinicalDocument.informant`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ relatedEntity
560. ClinicalDocument.informant:informant1
Slice Name | informant1
Short | informant
Comments | MAY contain zero or more [0..*] informant (CONF:1198-28681) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
562. ClinicalDocument.informant:informant1.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
564. ClinicalDocument.informant:informant1.realmCode
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
566. ClinicalDocument.informant:informant1.typeId
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
568. ClinicalDocument.informant:informant1.templateId
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
570. ClinicalDocument.informant:informant1.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INF
572. ClinicalDocument.informant:informant1.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
574. ClinicalDocument.informant:informant1.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8002).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
576. ClinicalDocument.informant:informant1.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
578. ClinicalDocument.informant:informant1.assignedEntity.templateId
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
580. ClinicalDocument.informant:informant1.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-9945).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | 4537-9946: If assignedEntity/id is a provider then this id, **SHOULD** include zero or one [0..1] id where id/@root ="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-9946). ()
582. ClinicalDocument.informant:informant1.assignedEntity.sdtcIdentifiedBy
Definition | Element AssignedEntity.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
584. ClinicalDocument.informant:informant1.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).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
586. ClinicalDocument.informant:informant1.assignedEntity.addr
Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
588. ClinicalDocument.informant:informant1.assignedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
590. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-8221).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
592. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
594. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
596. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.templateId
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
598. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name
Definition | A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
600. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
602. ClinicalDocument.informant:informant1.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
604. ClinicalDocument.informant:informant1.relatedEntity
Comments | SHALL contain exactly one [1..1] relatedEntity (CONF:1198-28682).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
606. ClinicalDocument.informant:informant1.relatedEntity.classCode
Control | 1..1
Binding | The codes SHALL be taken from RoleClassMutualRelationship
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
608. ClinicalDocument.informant:informant1.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
610. ClinicalDocument.informant:informant1.relatedEntity.code
Comments | This relatedEntity MAY contain zero or one [0..1] code (CONF:1198-28683).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from PersonalRelationshipRoleType
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
612. ClinicalDocument.informant:informant1.relatedEntity.code.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
614. ClinicalDocument.informant:informant1.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).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
616. ClinicalDocument.informant:informant1.relatedEntity.code.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
618. ClinicalDocument.informant:informant1.relatedEntity.code.codeSystemName
Definition | The common name of the coding system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
620. ClinicalDocument.informant:informant1.relatedEntity.code.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
622. ClinicalDocument.informant:informant1.relatedEntity.code.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
624. ClinicalDocument.informant:informant1.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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
626. ClinicalDocument.informant:informant1.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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
628. ClinicalDocument.informant:informant1.relatedEntity.code.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
630. ClinicalDocument.informant:informant1.relatedEntity.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
632. ClinicalDocument.informant:informant1.relatedEntity.code.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
634. ClinicalDocument.informant:informant1.relatedEntity.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
636. ClinicalDocument.informant:informant1.relatedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
638. ClinicalDocument.informant:informant1.relatedEntity.effectiveTime
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
640. ClinicalDocument.informant:informant1.relatedEntity.relatedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
642. ClinicalDocument.informant:informant2
Slice Name | informant2
Short | informant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
644. ClinicalDocument.informant:informant2.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
646. ClinicalDocument.informant:informant2.realmCode
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
648. ClinicalDocument.informant:informant2.typeId
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
650. ClinicalDocument.informant:informant2.templateId
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
652. ClinicalDocument.informant:informant2.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INF
654. ClinicalDocument.informant:informant2.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
656. ClinicalDocument.informant:informant2.assignedEntity
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
658. ClinicalDocument.informant:informant2.relatedEntity
Comments | SHALL contain exactly one [1..1] relatedEntity (CONF:4537-31356).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
660. ClinicalDocument.custodian
Short | The 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Custodian
662. ClinicalDocument.custodian.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
664. ClinicalDocument.custodian.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ENT
666. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
668. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
670. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
672. ClinicalDocument.custodian.assignedCustodian
Comments | This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:1198-28686).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedCustodian
674. ClinicalDocument.custodian.assignedCustodian.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
676. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
678. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
Short | The 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CustodianOrganization
680. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ORG
682. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
684. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
686. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
Short | The 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
688. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
690. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
692. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
694. 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
696. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
698. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name
Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:4537-5524).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ON
700. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom
Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:4537-5525).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
702. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
704. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
706. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
708. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
710. 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.
Short | Base 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
712. ClinicalDocument.informationRecipient
Short | The 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).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient
714. ClinicalDocument.informationRecipient.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
716. ClinicalDocument.informationRecipient.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | PRCP
718. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
720. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
722. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
724. ClinicalDocument.informationRecipient.intendedRecipient
Comments | The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:1198-28691).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IntendedRecipient
726. ClinicalDocument.informationRecipient.intendedRecipient.classCode
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | ASSIGNED
728. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
730. ClinicalDocument.informationRecipient.intendedRecipient.id
Short | The 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).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
732. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
734. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
736. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
738. 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.
Short | For 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
740. ClinicalDocument.informationRecipient.intendedRecipient.id.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
742. ClinicalDocument.informationRecipient.intendedRecipient.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
744. ClinicalDocument.informationRecipient.intendedRecipient.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
746. ClinicalDocument.informationRecipient.intendedRecipient.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
748. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient
Comments | This intendedRecipient MAY contain zero or one [0..1] informationRecipient (CONF:4537-5567).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
750. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
752. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
754. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
756. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
758. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
760. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization
Comments | This intendedRecipient MAY contain zero or one [0..1] receivedOrganization (CONF:4537-5577).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
762. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
764. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ORG
766. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
768. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.realmCode
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
770. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
772. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
774. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
776. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name
Comments | The receivedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4537-5578).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ON
778. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
780. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
782. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCode
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from OrganizationIndustryClassNAICS
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
784. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
786. ClinicalDocument.legalAuthenticator
Short | In 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).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator
788. ClinicalDocument.legalAuthenticator.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
790. ClinicalDocument.legalAuthenticator.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | LA
792. ClinicalDocument.legalAuthenticator.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
794. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
796. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
798. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
800. 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.
Short | Base for all types and resources
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5580).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-10127: **SHALL** be precise to the day (CONF:81-10127). () 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). () 81-10129: **MAY** be precise to the second (CONF:81-10129). () 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
802. ClinicalDocument.legalAuthenticator.signatureCode
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:4537-5583).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
804. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
806. 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).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | S
808. ClinicalDocument.legalAuthenticator.signatureCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
810. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
812. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
814. ClinicalDocument.legalAuthenticator.signatureCode.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
816. 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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
818. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
820. ClinicalDocument.legalAuthenticator.signatureCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
822. ClinicalDocument.legalAuthenticator.signatureCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
824. ClinicalDocument.legalAuthenticator.signatureCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
826. ClinicalDocument.legalAuthenticator.sdtcSignatureText
Short | The 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.
Comments | The legalAuthenticator, if present, MAY contain zero or one [0..1] sdtc:signatureText (CONF:4537-30810).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`signatureText`.
828. ClinicalDocument.legalAuthenticator.assignedEntity
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28695).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
830. ClinicalDocument.legalAuthenticator.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
832. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
834. ClinicalDocument.legalAuthenticator.assignedEntity.id
Short | The 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
836. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
838. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
840. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
842. 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.
Comments | Such ids MAY contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16823).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
844. ClinicalDocument.legalAuthenticator.assignedEntity.id.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
846. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcIdentifiedBy
Definition | Element AssignedEntity.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
848. ClinicalDocument.legalAuthenticator.assignedEntity.code
Comments | This assignedEntity MAY contain zero or one [0..1] code (CONF:1198-28697).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
850. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
852. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
854. ClinicalDocument.legalAuthenticator.assignedEntity.code.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
856. ClinicalDocument.legalAuthenticator.assignedEntity.code.codeSystemName
Definition | The common name of the coding system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
858. ClinicalDocument.legalAuthenticator.assignedEntity.code.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
860. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
862. 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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
864. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
866. ClinicalDocument.legalAuthenticator.assignedEntity.code.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
868. ClinicalDocument.legalAuthenticator.assignedEntity.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
870. ClinicalDocument.legalAuthenticator.assignedEntity.code.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
872. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
874. ClinicalDocument.legalAuthenticator.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5595).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
876. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
878. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
880. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
882. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
884. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5597).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
886. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
888. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
890. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
892. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
894. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
896. ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
898. ClinicalDocument.authenticator
Comments | MAY contain zero or more [0..*] authenticator (CONF:1198-28699).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authenticator
Slicing | This element introduces a set of slices on `ClinicalDocument.authenticator`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ ClinicalDocument.signatureCode value @ ClinicalDocument.assignedEntity value @ ClinicalDocument.time
900. ClinicalDocument.authenticator.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
902. ClinicalDocument.authenticator.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | AUTHEN
904. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
906. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
908. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
910. ClinicalDocument.authenticator.time
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
912. ClinicalDocument.authenticator.signatureCode
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
914. ClinicalDocument.authenticator.sdtcSignatureText
Definition | Element Authenticator.sdtcSignatureText
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`signatureText`.
916. ClinicalDocument.authenticator.assignedEntity
Comments | The authenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28700).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
918. ClinicalDocument.authenticator.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
920. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
922. ClinicalDocument.authenticator.assignedEntity.id
Short | The 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
924. ClinicalDocument.authenticator.assignedEntity.sdtcIdentifiedBy
Definition | Element AssignedEntity.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
926. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
928. ClinicalDocument.authenticator.assignedEntity.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
930. ClinicalDocument.authenticator.assignedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
932. ClinicalDocument.authenticator.assignedEntity.assignedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
934. ClinicalDocument.authenticator.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
936. ClinicalDocument.authenticator:authenticator1
Slice Name | authenticator1
Short | authenticator
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authenticator
938. ClinicalDocument.authenticator:authenticator1.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
940. ClinicalDocument.authenticator:authenticator1.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | AUTHEN
942. ClinicalDocument.authenticator:authenticator1.realmCode
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
944. ClinicalDocument.authenticator:authenticator1.typeId
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
946. ClinicalDocument.authenticator:authenticator1.templateId
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
948. ClinicalDocument.authenticator:authenticator1.time
Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.
Short | Base for all types and resources
Comments | SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5608).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-10127: **SHALL** be precise to the day (CONF:81-10127). () 81-10128: **SHOULD** be precise to the minute (CONF:81-10128). () 81-10129: **MAY** be precise to the second (CONF:81-10129). () 81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
950. ClinicalDocument.authenticator:authenticator1.signatureCode
Comments | SHALL contain exactly one [1..1] signatureCode (CONF:4537-5610).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
952. ClinicalDocument.authenticator:authenticator1.signatureCode.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
954. ClinicalDocument.authenticator:authenticator1.signatureCode.code
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
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).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | S
956. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
958. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
960. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
962. ClinicalDocument.authenticator:authenticator1.signatureCode.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
964. ClinicalDocument.authenticator:authenticator1.signatureCode.sdtcValueSet
Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
966. ClinicalDocument.authenticator:authenticator1.signatureCode.sdtcValueSetVersion
Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
968. ClinicalDocument.authenticator:authenticator1.signatureCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
970. ClinicalDocument.authenticator:authenticator1.signatureCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
972. ClinicalDocument.authenticator:authenticator1.signatureCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
974. ClinicalDocument.authenticator:authenticator1.sdtcSignatureText
Definition | Element Authenticator.sdtcSignatureText
Short | The 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.
Comments | MAY contain zero or one [0..1] sdtc:signatureText (CONF:4537-30811).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`signatureText`.
976. ClinicalDocument.authenticator:authenticator1.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5612).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
978. ClinicalDocument.authenticator:authenticator1.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
980. ClinicalDocument.authenticator:authenticator1.assignedEntity.templateId
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
982. ClinicalDocument.authenticator:authenticator1.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5613).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
984. ClinicalDocument.authenticator:authenticator1.assignedEntity.id.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
986. ClinicalDocument.authenticator:authenticator1.assignedEntity.id.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
988. ClinicalDocument.authenticator:authenticator1.assignedEntity.id.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
990. ClinicalDocument.authenticator:authenticator1.assignedEntity.id.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16824).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
992. ClinicalDocument.authenticator:authenticator1.assignedEntity.id.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
994. ClinicalDocument.authenticator:authenticator1.assignedEntity.sdtcIdentifiedBy
Definition | Element AssignedEntity.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
996. ClinicalDocument.authenticator:authenticator1.assignedEntity.code
Comments | This assignedEntity MAY contain zero or one [0..1] code (CONF:4537-16825).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System RoleCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
998. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1000. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.code
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
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).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
1002. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
1004. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codeSystemName
Definition | The common name of the coding system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
1006. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
1008. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
1010. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.sdtcValueSet
Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
1012. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.sdtcValueSetVersion
Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
1014. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
1016. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
1018. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
1020. ClinicalDocument.authenticator:authenticator1.assignedEntity.addr
Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
1022. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5622).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
1024. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1026. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
1028. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.useablePeriod
Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
1030. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.use
Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.
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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
1032. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5624).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
1034. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
1036. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
1038. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.templateId
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1040. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.name
Definition | A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
1042. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
1044. ClinicalDocument.authenticator:authenticator1.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1046. ClinicalDocument.participant
Short | The 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).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant1
Invariants | 4537-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). () 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). ()
1048. ClinicalDocument.participant.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1050. ClinicalDocument.participant.typeCode
Short | Unless 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).
Control | 1..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
1052. ClinicalDocument.participant.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
1054. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1056. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1058. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1060. ClinicalDocument.participant.functionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1062. ClinicalDocument.participant.time
Comments | MAY contain zero or one [0..1] time (CONF:4537-10004).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
1064. ClinicalDocument.participant.associatedEntity
Comments | The participant, if present, SHALL contain exactly one [1..1] associatedEntity (CONF:1198-28705).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
1066. ClinicalDocument.participant.associatedEntity.classCode
Control | 1..1
Binding | The codes SHALL be taken from RoleClassAssociative
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
1068. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1070. ClinicalDocument.participant.associatedEntity.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1072. ClinicalDocument.participant.associatedEntity.sdtcIdentifiedBy
Definition | Element AssociatedEntity.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
1074. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1076. ClinicalDocument.participant.associatedEntity.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
1078. ClinicalDocument.participant.associatedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
1080. ClinicalDocument.participant.associatedEntity.associatedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
1082. ClinicalDocument.participant.associatedEntity.scopingOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1084. ClinicalDocument.inFulfillmentOf
Comments | MAY contain zero or more [0..*] inFulfillmentOf (CONF:1198-28707).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf
1086. ClinicalDocument.inFulfillmentOf.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1088. ClinicalDocument.inFulfillmentOf.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | FLFS
1090. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1092. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1094. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1096. ClinicalDocument.inFulfillmentOf.order
Comments | The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:1198-28708).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Order
1098. ClinicalDocument.inFulfillmentOf.order.classCode
Control | 1..1
Binding | The codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | ACT
1100. ClinicalDocument.inFulfillmentOf.order.moodCode
Control | 0..1
Binding | The codes SHALL be taken from ActMoodIntent
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | RQO
1102. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1104. ClinicalDocument.inFulfillmentOf.order.id
Short | A 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1106. ClinicalDocument.inFulfillmentOf.order.code
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System ActCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1108. ClinicalDocument.inFulfillmentOf.order.priorityCode
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActPriority
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1110. ClinicalDocument.documentationOf
Comments | MAY contain zero or more [0..*] documentationOf (CONF:1198-28710).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf
1112. ClinicalDocument.documentationOf.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1114. ClinicalDocument.documentationOf.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DOC
1116. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1118. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1120. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1122. ClinicalDocument.documentationOf.serviceEvent
Comments | The documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:1198-28711).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent
1124. ClinicalDocument.documentationOf.serviceEvent.classCode
Control | 1..1
Binding | The codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | ACT
1126. ClinicalDocument.documentationOf.serviceEvent.moodCode
Control | 0..1
Binding | The codes SHALL be taken from ActMood
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | EVN
1128. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1130. ClinicalDocument.documentationOf.serviceEvent.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1132. ClinicalDocument.documentationOf.serviceEvent.code
Definition | Drawn from concept domain ActCode
Short | The 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).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1134. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Comments | This serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:4537-14837).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
1136. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1138. 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.
Control | 0..1
Type | string(ts: Point in Time)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML Format | In the XML format, this property is represented as an attribute.
1140. 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.
Control | 0..1
Binding | The codes SHALL be taken from SetOperator
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | I
1142. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low
Definition | This is the low limit of the interval.
Comments | This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-14838).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | Low Boundary
1144. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Label | Central Value
1146. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ
Label | Width
1148. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
Definition | This is the high limit of the interval.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | High Boundary
1150. ClinicalDocument.documentationOf.serviceEvent.performer
Comments | This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:1198-28713).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer1
1152. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1154. 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).
Control | 1..1
Binding | The codes SHALL be taken from x_ServiceEventPerformer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
1156. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1158. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1160. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1162. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode
Short | The functionCode SHALL be selected from value set ParticipationType 2.16.840.1.113883.1.11.10901 When indicating the performer was the primary care physician the functionCode shall be ='PCP'
Comments | The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:1198-28714).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1164. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1166. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Care Team Member Function
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
1168. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
1170. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
1172. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
1174. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
1176. 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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
1178. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
1180. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
1182. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
1184. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
1186. ClinicalDocument.documentationOf.serviceEvent.performer.time
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
1188. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Comments | The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28715).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1190. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
1192. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1194. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
Short | The 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1196. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1198. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
1200. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
1202. 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
1204. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
1206. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy
Definition | Element AssignedEntity.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
1208. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code
Short | If 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).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1210. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
1212. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
1214. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
1216. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1218. ClinicalDocument.relatedDocument
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument
1220. ClinicalDocument.authorization
Comments | MAY contain zero or more [0..*] authorization (CONF:4537-16792) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authorization
1222. ClinicalDocument.authorization.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1224. ClinicalDocument.authorization.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | AUTH
1226. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1228. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1230. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1232. ClinicalDocument.authorization.consent
Comments | SHALL contain exactly one [1..1] consent (CONF:4537-16793).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Consent
1234. ClinicalDocument.authorization.consent.classCode
Control | 0..1
Binding | The codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | CONS
1236. ClinicalDocument.authorization.consent.moodCode
Control | 0..1
Binding | The codes SHALL be taken from ActMood
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | EVN
1238. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1240. ClinicalDocument.authorization.consent.id
Comments | This consent MAY contain zero or more [0..*] id (CONF:4537-16794).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1242. ClinicalDocument.authorization.consent.code
Short | The 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).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System ActCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1244. ClinicalDocument.authorization.consent.statusCode
Comments | This consent SHALL contain exactly one [1..1] statusCode (CONF:4537-16797).
Control | 1..1
Binding | The codes SHALL be taken from ActStatus
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1246. ClinicalDocument.authorization.consent.statusCode.code
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).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | completed
1248. ClinicalDocument.componentOf
Comments | MAY contain zero or one [0..1] componentOf (CONF:4537-9955).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ComponentOf
1250. ClinicalDocument.componentOf.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1252. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1254. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1256. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1258. ClinicalDocument.componentOf.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ActRelationshipHasComponent
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1260. ClinicalDocument.componentOf.encompassingEncounter
Comments | The componentOf, if present, SHALL contain exactly one [1..1] encompassingEncounter (CONF:4537-9956).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/EncompassingEncounter
1262. ClinicalDocument.componentOf.encompassingEncounter.classCode
Control | 0..1
Binding | The codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ENC
1264. ClinicalDocument.componentOf.encompassingEncounter.moodCode
Control | 0..1
Binding | The codes SHALL be taken from ActMood
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | EVN
1266. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1268. ClinicalDocument.componentOf.encompassingEncounter.id
Comments | This encompassingEncounter SHALL contain at least one [1..*] id (CONF:4537-9959).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1270. ClinicalDocument.componentOf.encompassingEncounter.code
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActEncounterCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1272. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime
Comments | This encompassingEncounter SHALL contain exactly one [1..1] effectiveTime (CONF:4537-9958).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
1274. ClinicalDocument.componentOf.encompassingEncounter.sdtcAdmissionReferralSourceCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`admissionReferralSourceCode`.
1276. ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from USEncounterDischargeDisposition
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1278. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1280. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1282. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1284. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1286. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1288. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | RESP
1290. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1292. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant
1294. 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).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1296. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1298. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1300. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1302. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1304. ClinicalDocument.componentOf.encompassingEncounter.location.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationTargetLocation
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | LOC
1306. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility
1308. ClinicalDocument.component
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Component