This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) generated with FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions
Active as of 2023-01-16 |
Definitions for the 2.16.840.1.113883.10.20.22.5.1 resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. PN | |
Invariants | Defined on this element 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). (: null) |
2. PN.use | |
Binding | The codes SHALL be taken from EntityNameUseThe codes SHALL be taken from PersonNameUse |
Requirements | MAY contain zero or one [0..1] @use, which SHALL be selected from ValueSet EntityNameUse urn:oid:2.16.840.1.113883.1.11.15913 STATIC 2005-05-01 (CONF:81-7154). |
3. PN.family | |
Control | 10..1* |
Requirements | SHALL contain exactly one [1..1] family (CONF:81-7159). |
4. PN.family.qualifier | |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityPersonNamePartQualifier |
Requirements | This family MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7160). |
5. PN.given | |
Control | 10..* |
Requirements | SHALL contain at least one [1..*] given (CONF:81-7157). |
Invariants | Defined on this element 81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163). (: null) |
6. PN.given.qualifier | |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityPersonNamePartQualifier |
Requirements | Such givens MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7158). |
7. PN.prefix | |
Requirements | MAY contain zero or more [0..*] prefix (CONF:81-7155). |
8. PN.prefix.qualifier | |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityPersonNamePartQualifier |
Requirements | The prefix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7156). |
9. PN.suffix | |
Control | 0..1* |
Requirements | MAY contain zero or one [0..1] suffix (CONF:81-7161). |
10. PN.suffix.qualifier | |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityPersonNamePartQualifier |
Requirements | The suffix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7162). |
Guidance on how to interpret the contents of this table can be found here.
1. PN | |
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). Base definition for all types defined in FHIR type system. |
Control | 10..* |
Invariants | Defined on this element 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
2. PN.use | |
Definition | A set of codes advising a system or user which name in a set of like names to select for a given purpose. A name without specific use code might be a default name useful for any purpose, but a name with a specific use code would be preferred for that respective purpose |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityNameUse |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Requirements | MAY contain zero or one [0..1] @use, which SHALL be selected from ValueSet EntityNameUse urn:oid:2.16.840.1.113883.1.11.15913 STATIC 2005-05-01 (CONF:81-7154). |
3. PN.family | |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ENXP |
Requirements | SHALL contain exactly one [1..1] family (CONF:81-7159). |
4. PN.family.compression | |
Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
Control | 0..0 |
Binding | The codes SHALL be taken from CompressionAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
5. PN.family.integrityCheck | |
Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
Control | 0..0 |
Type | base64Binary |
XML Representation | In the XML format, this property is represented as an attribute. |
6. PN.family.integrityCheckAlgorithm | |
Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
Control | 0..0 |
Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
7. PN.family.reference | |
Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
8. PN.family.thumbnail | |
Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
9. PN.family.qualifier | |
Definition | qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records. |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityPersonNamePartQualifier |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Requirements | This family MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7160). |
10. PN.given | |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ENXP |
Requirements | SHALL contain at least one [1..*] given (CONF:81-7157). |
Invariants | Defined on this element 81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163). (: null) |
11. PN.given.compression | |
Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
Control | 0..0 |
Binding | The codes SHALL be taken from CompressionAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
12. PN.given.integrityCheck | |
Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
Control | 0..0 |
Type | base64Binary |
XML Representation | In the XML format, this property is represented as an attribute. |
13. PN.given.integrityCheckAlgorithm | |
Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
Control | 0..0 |
Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
14. PN.given.reference | |
Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
15. PN.given.thumbnail | |
Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
16. PN.given.qualifier | |
Definition | qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records. |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityPersonNamePartQualifier |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Requirements | Such givens MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7158). |
17. PN.prefix | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ENXP |
Requirements | MAY contain zero or more [0..*] prefix (CONF:81-7155). |
18. PN.prefix.compression | |
Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
Control | 0..0 |
Binding | The codes SHALL be taken from CompressionAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
19. PN.prefix.integrityCheck | |
Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
Control | 0..0 |
Type | base64Binary |
XML Representation | In the XML format, this property is represented as an attribute. |
20. PN.prefix.integrityCheckAlgorithm | |
Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
Control | 0..0 |
Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
21. PN.prefix.reference | |
Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
22. PN.prefix.thumbnail | |
Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
23. PN.prefix.qualifier | |
Definition | qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records. |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityPersonNamePartQualifier |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Requirements | The prefix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7156). |
24. PN.suffix | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ENXP |
Requirements | MAY contain zero or one [0..1] suffix (CONF:81-7161). |
25. PN.suffix.compression | |
Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
Control | 0..0 |
Binding | The codes SHALL be taken from CompressionAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
26. PN.suffix.integrityCheck | |
Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
Control | 0..0 |
Type | base64Binary |
XML Representation | In the XML format, this property is represented as an attribute. |
27. PN.suffix.integrityCheckAlgorithm | |
Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
Control | 0..0 |
Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
28. PN.suffix.reference | |
Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
29. PN.suffix.thumbnail | |
Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
30. PN.suffix.qualifier | |
Definition | qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records. |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityPersonNamePartQualifier |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Requirements | The suffix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7162). |
Guidance on how to interpret the contents of this table can be found here.
1. PN | |
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). |
Control | 1..* |
2. PN.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 |
XML Representation | In the XML format, this property is represented as an attribute. |
3. PN.use | |
Definition | A set of codes advising a system or user which name in a set of like names to select for a given purpose. A name without specific use code might be a default name useful for any purpose, but a name with a specific use code would be preferred for that respective purpose |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityNameUse |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Requirements | MAY contain zero or one [0..1] @use, which SHALL be selected from ValueSet EntityNameUse urn:oid:2.16.840.1.113883.1.11.15913 STATIC 2005-05-01 (CONF:81-7154). |
4. PN.delimiter | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ENXP |
5. PN.family | |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ENXP |
Requirements | SHALL contain exactly one [1..1] family (CONF:81-7159). |
6. PN.family.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 |
XML Representation | In the XML format, this property is represented as an attribute. |
7. PN.family.charset | |
Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
8. PN.family.compression | |
Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
Control | 0..0 |
Binding | The codes SHALL be taken from CompressionAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
9. PN.family.integrityCheck | |
Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
Control | 0..0 |
Type | base64Binary |
XML Representation | In the XML format, this property is represented as an attribute. |
10. PN.family.integrityCheckAlgorithm | |
Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
Control | 0..0 |
Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
11. PN.family.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
12. PN.family.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | text/plain |
13. PN.family.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
14. PN.family.data[x] | |
Definition | The string value |
Control | 0..1 |
Type | string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
XML Representation | In the XML format, this property is represented as unadorned text. |
15. PN.family.reference | |
Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
16. PN.family.thumbnail | |
Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
17. PN.family.partType | |
Definition | Indicates whether the name part is a given name, family name, prefix, suffix, etc. |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityNamePartType |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
18. PN.family.qualifier | |
Definition | qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records. |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityPersonNamePartQualifier |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Requirements | This family MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7160). |
19. PN.given | |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ENXP |
Requirements | SHALL contain at least one [1..*] given (CONF:81-7157). |
Invariants | Defined on this element 81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163). (: ) |
20. PN.given.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 |
XML Representation | In the XML format, this property is represented as an attribute. |
21. PN.given.charset | |
Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
22. PN.given.compression | |
Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
Control | 0..0 |
Binding | The codes SHALL be taken from CompressionAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
23. PN.given.integrityCheck | |
Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
Control | 0..0 |
Type | base64Binary |
XML Representation | In the XML format, this property is represented as an attribute. |
24. PN.given.integrityCheckAlgorithm | |
Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
Control | 0..0 |
Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
25. PN.given.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
26. PN.given.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | text/plain |
27. PN.given.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
28. PN.given.data[x] | |
Definition | The string value |
Control | 0..1 |
Type | string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
XML Representation | In the XML format, this property is represented as unadorned text. |
29. PN.given.reference | |
Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
30. PN.given.thumbnail | |
Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
31. PN.given.partType | |
Definition | Indicates whether the name part is a given name, family name, prefix, suffix, etc. |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityNamePartType |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
32. PN.given.qualifier | |
Definition | qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records. |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityPersonNamePartQualifier |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Requirements | Such givens MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7158). |
33. PN.prefix | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ENXP |
Requirements | MAY contain zero or more [0..*] prefix (CONF:81-7155). |
34. PN.prefix.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 |
XML Representation | In the XML format, this property is represented as an attribute. |
35. PN.prefix.charset | |
Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
36. PN.prefix.compression | |
Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
Control | 0..0 |
Binding | The codes SHALL be taken from CompressionAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
37. PN.prefix.integrityCheck | |
Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
Control | 0..0 |
Type | base64Binary |
XML Representation | In the XML format, this property is represented as an attribute. |
38. PN.prefix.integrityCheckAlgorithm | |
Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
Control | 0..0 |
Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
39. PN.prefix.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
40. PN.prefix.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | text/plain |
41. PN.prefix.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
42. PN.prefix.data[x] | |
Definition | The string value |
Control | 0..1 |
Type | string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
XML Representation | In the XML format, this property is represented as unadorned text. |
43. PN.prefix.reference | |
Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
44. PN.prefix.thumbnail | |
Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
45. PN.prefix.partType | |
Definition | Indicates whether the name part is a given name, family name, prefix, suffix, etc. |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityNamePartType |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
46. PN.prefix.qualifier | |
Definition | qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records. |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityPersonNamePartQualifier |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Requirements | The prefix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7156). |
47. PN.suffix | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ENXP |
Requirements | MAY contain zero or one [0..1] suffix (CONF:81-7161). |
48. PN.suffix.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 |
XML Representation | In the XML format, this property is represented as an attribute. |
49. PN.suffix.charset | |
Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
50. PN.suffix.compression | |
Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
Control | 0..0 |
Binding | The codes SHALL be taken from CompressionAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
51. PN.suffix.integrityCheck | |
Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
Control | 0..0 |
Type | base64Binary |
XML Representation | In the XML format, this property is represented as an attribute. |
52. PN.suffix.integrityCheckAlgorithm | |
Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
Control | 0..0 |
Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
53. PN.suffix.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
54. PN.suffix.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | text/plain |
55. PN.suffix.representation | |
Definition | Specifies the representation of the binary data that is the content of the binary data value |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | TXT |
56. PN.suffix.data[x] | |
Definition | The string value |
Control | 0..1 |
Type | string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
XML Representation | In the XML format, this property is represented as unadorned text. |
57. PN.suffix.reference | |
Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
58. PN.suffix.thumbnail | |
Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
59. PN.suffix.partType | |
Definition | Indicates whether the name part is a given name, family name, prefix, suffix, etc. |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityNamePartType |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
60. PN.suffix.qualifier | |
Definition | qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records. |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityPersonNamePartQualifier |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Requirements | The suffix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7162). |
61. PN.other | |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as unadorned text. |
62. PN.validTime | |
Definition | An interval of time specifying the time during which the name is or was used for the entity. This accomodates the fact that people change names for people, places and things. |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |