Consolidated CDA
3.0.0-ballot - ballot
Consolidated CDA
3.0.0-ballot - ballot
This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions
| Draft as of 2023-12-21 |
Definitions for the ProvenanceAuthorParticipation logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. Author | |
| Logical Container | ClinicalDocument (CDA Class) |
| Validation | Instances of this type are validated by templateId |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. Author.templateId | |
| Control | 1..? |
| Slicing | This element introduces a set of slices on Author.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: |
| 4. Author.templateId:provenance-author | |
| Slice Name | provenance-author |
| Control | 1..1 |
| 6. Author.templateId:provenance-author.root | |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.10.20.22.5.6 |
| 8. Author.templateId:provenance-author.extension | |
| Control | 1..? |
| Pattern Value | 2019-10-01 |
| 10. Author.time | |
| Short | (USCDI) Author Time Stamp |
| Comments | SHALL contain exactly one [1..1] time (CONF:4515-32983). |
| 12. Author.assignedAuthor | |
| Comments | SHALL contain exactly one [1..1] assignedAuthor (CONF:4515-32975). |
| Invariants | author-details: Authors require addr, telecom, and either assignedPerson/name or assignedAuthoringDevice/manufacturerModelName. These may be present on this author or on another instance of an Author Participation in the document that has an id that matches the first id of this author. (nullFlavor.exists() or (addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())) or (%resource.descendants().ofType(CDA.AssignedAuthor).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists()))))4515-64: If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64). ( representedOrganization.exists() or (%resource.descendants().ofType(CDA.Author).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.5.6' and $this.extension = '2019-10-01') and assignedAuthor.representedOrganization.exists() and assignedAuthor.id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))))should-code: SHOULD contain code ( code.exists()) |
| 14. Author.assignedAuthor.id | |
| Comments | This assignedAuthor SHALL contain exactly one [1..1] id (CONF:4515-20) such that. it This assignedAuthor SHALL contain at least one [1..*] id (CONF:4515-2). |
| Slicing | This element introduces a set of slices on Author.assignedAuthor.id. The slices are unordered and Open, and can be differentiated using the following discriminators: |
| 16. Author.assignedAuthor.id:npi | |
| Slice Name | npi |
| Comments | This assignedAuthor SHALL contain exactly one [1..1] id (CONF:4515-20) such that it |
| Control | 1..1 |
| 18. Author.assignedAuthor.id:npi.nullFlavor | |
| Short | If NPI is unknown, set @nullFlavor to UNK |
| 20. Author.assignedAuthor.id:npi.root | |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4515-22). |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.4.6 |
| 22. Author.assignedAuthor.id:npi.extension | |
| Comments | SHOULD contain zero or one [0..1] @extension (CONF:4515-23). |
| 24. 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:4515-32979). |
| Binding | For example codes, see v3 Code System RoleCode See additional bindings |
| 26. Author.assignedAuthor.addr | |
| Short | Required on at least one instance of this author in the document |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 28. Author.assignedAuthor.telecom | |
| Short | Required on at least one instance of this author in the document |
| 30. Author.assignedAuthor.assignedPerson | |
| Short | assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document |
| 32. Author.assignedAuthor.assignedPerson.name | |
| Comments | The assignedPerson, if present, SHALL contain at least one [1..*] name (CONF:4515-32977). |
| Control | 1..? |
| Invariants | shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). (nullFlavor.exists() or item.family.count() = 1)should-given: SHOULD contain given ( item.given.exists()) |
| 34. Author.assignedAuthor.assignedPerson.name.item | |
| 36. Author.assignedAuthor.assignedPerson.name.item.family | |
| Short | Family required |
| Comments | Such names SHALL contain exactly one [1..1] family (CONF:4515-17). |
| 38. Author.assignedAuthor.assignedPerson.name.item.given | |
| Short | SHOULD contain given |
| Comments | Such names SHOULD contain zero or more [0..*] given (CONF:4515-18). |
| 40. Author.assignedAuthor.assignedAuthoringDevice | |
| Comments | This assignedAuthor MAY contain zero or one [0..1] assignedAuthoringDevice (CONF:4515-32). |
| 42. Author.assignedAuthor.representedOrganization | |
| Short | (USCDI) Author Organization - If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (See - CONF:4440-64). |
| Comments | This assignedAuthor MAY contain zero or one [0..1] representedOrganization (CONF:4515-32978). |
| Invariants | provenance-org-details: If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. (nullFlavor = 'NA' or (id.where(root='2.16.840.1.113883.4.2').exists() and id.where(root='2.16.840.1.113883.4.6').exists() and name.exists()))should-telecom: SHOULD contain telecom ( telecom.exists()) |
| 44. Author.assignedAuthor.representedOrganization.nullFlavor | |
| Short | A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician |
| Comments | The representedOrganization, if present, MAY contain zero or one [0..1] @nullFlavor (CONF:4515-35). |
| 46. Author.assignedAuthor.representedOrganization.id | |
| Comments | The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-28) such that it. The representedOrganization, if present, SHALL contain at least one [1..*] id (CONF:4515-32981). |
| Slicing | This element introduces a set of slices on Author.assignedAuthor.representedOrganization.id. The slices are unordered and Open, and can be differentiated using the following discriminators: |
| 48. Author.assignedAuthor.representedOrganization.id:taxId | |
| Slice Name | taxId |
| Comments | The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-24) such that it |
| Control | 0..1 |
| 50. Author.assignedAuthor.representedOrganization.id:taxId.nullFlavor | |
| Short | If Tax ID Number is unknown, set @nullFlavor to UNK |
| 52. Author.assignedAuthor.representedOrganization.id:taxId.root | |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.2" Tax ID Number (CONF:4515-26). |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.4.2 |
| 54. Author.assignedAuthor.representedOrganization.id:taxId.extension | |
| Comments | SHOULD contain zero or one [0..1] @extension (CONF:4515-32982). |
| 56. Author.assignedAuthor.representedOrganization.id:npi | |
| Slice Name | npi |
| Comments | The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-28) such that it |
| Control | 0..1 |
| 58. Author.assignedAuthor.representedOrganization.id:npi.nullFlavor | |
| Short | If NPI is unknown, set @nullFlavor to UNK |
| 60. Author.assignedAuthor.representedOrganization.id:npi.root | |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4515-30). |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.4.6 |
| 62. Author.assignedAuthor.representedOrganization.id:npi.extension | |
| Comments | SHOULD contain zero or one [0..1] @extension (CONF:4515-31). |
| 64. Author.assignedAuthor.representedOrganization.name | |
| Comments | The representedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4515-11). |
| Control | 0..1 |
| 66. Author.assignedAuthor.representedOrganization.telecom | |
| Comments | The representedOrganization, if present, SHOULD contain zero or more [0..*] telecom (CONF:4515-12). |
Guidance on how to interpret the contents of this table can be found here
| 0. Author | |
| Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Control | 10..1* |
| Is Modifier | false |
| Logical Container | ClinicalDocument (CDA Class) |
| Validation | Instances of this type are validated by templateId |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. 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 | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on Author.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: |
| 4. Author.templateId:provenance-author | |
| Slice Name | provenance-author |
| Definition | When valued in an instance, this attribute 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 | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 6. Author.templateId:provenance-author.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| 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.5.6 |
| 8. Author.templateId:provenance-author.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| 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 | 2019-10-01 |
| 10. Author.time | |
| Short | (USCDI) Author Time Stamp |
| Comments | SHALL contain exactly one [1..1] time (CONF:4515-32983). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| 12. Author.assignedAuthor | |
| Comments | SHALL contain exactly one [1..1] assignedAuthor (CONF:4515-32975). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor |
| Invariants | author-details: Authors require addr, telecom, and either assignedPerson/name or assignedAuthoringDevice/manufacturerModelName. These may be present on this author or on another instance of an Author Participation in the document that has an id that matches the first id of this author. (nullFlavor.exists() or (addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())) or (%resource.descendants().ofType(CDA.AssignedAuthor).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists()))))4515-64: If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64). ( representedOrganization.exists() or (%resource.descendants().ofType(CDA.Author).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.5.6' and $this.extension = '2019-10-01') and assignedAuthor.representedOrganization.exists() and assignedAuthor.id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))))should-code: SHOULD contain code ( code.exists()) |
| 14. Author.assignedAuthor.id | |
| Comments | This assignedAuthor SHALL contain exactly one [1..1] id (CONF:4515-20) such that. it This assignedAuthor SHALL contain at least one [1..*] id (CONF:4515-2). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on Author.assignedAuthor.id. The slices are unordered and Open, and can be differentiated using the following discriminators: |
| 16. Author.assignedAuthor.id:npi | |
| Slice Name | npi |
| Comments | This assignedAuthor SHALL contain exactly one [1..1] id (CONF:4515-20) such that it |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 18. Author.assignedAuthor.id:npi.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Short | If NPI is unknown, set @nullFlavor to UNK |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor |
| 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 |
| 20. Author.assignedAuthor.id:npi.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4515-22). |
| 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 |
| 22. Author.assignedAuthor.id:npi.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | SHOULD contain zero or one [0..1] @extension (CONF:4515-23). |
| 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 |
| 24. 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:4515-32979). |
| Control | 0..1 |
| Binding | For example codes, see v3 Code System RoleCode See additional bindings |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 26. 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 | Required on at least one instance of this author in the document |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| Is Modifier | false |
| Invariants | shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). ( nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))should-use: SHOULD contain @use ( nullFlavor.exists() or use.exists())should-country: SHOULD contain country ( nullFlavor.exists() or item.country.exists())81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) ( item.xmlText.empty())81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ( (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)) |
| 28. Author.assignedAuthor.telecom | |
| Short | Required on at least one instance of this author in the document |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 30. Author.assignedAuthor.assignedPerson | |
| Short | assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Person |
| 32. Author.assignedAuthor.assignedPerson.name | |
| Definition | A name associated with the person. |
| Short | A name associated with the person |
| Comments | The assignedPerson, if present, SHALL contain at least one [1..*] name (CONF:4515-32977). Person may have multiple names with different uses or applicable periods. |
| Control | 10..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PNHumanName |
| 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 | shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). (nullFlavor.exists() or item.family.count() = 1)should-given: SHOULD contain given ( item.given.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 34. Author.assignedAuthor.assignedPerson.name.item | |
| Definition | A series of items that constitute the name. |
| Control | 1..* |
| Type | http://hl7.org/fhir/StructureDefinition/Base |
| Choice Group | This is a repeating choice group that does not appear directly in the instance |
| Invariants | EN-1: Can only have only one of the possible item elements in each choice ((delimiter | family | given | prefix | suffix | xmlText).count() = 1) |
| 36. Author.assignedAuthor.assignedPerson.name.item.family | |
| Short | Family required |
| Comments | Such names SHALL contain exactly one [1..1] family (CONF:4515-17). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
| 38. Author.assignedAuthor.assignedPerson.name.item.given | |
| Short | SHOULD contain given |
| Comments | Such names SHOULD contain zero or more [0..*] given (CONF:4515-18). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
| 40. Author.assignedAuthor.assignedAuthoringDevice | |
| Comments | This assignedAuthor MAY contain zero or one [0..1] assignedAuthoringDevice (CONF:4515-32). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice |
| 42. Author.assignedAuthor.representedOrganization | |
| Short | (USCDI) Author Organization - If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (See - CONF:4440-64). |
| Comments | This assignedAuthor MAY contain zero or one [0..1] representedOrganization (CONF:4515-32978). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| Invariants | provenance-org-details: If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. (nullFlavor = 'NA' or (id.where(root='2.16.840.1.113883.4.2').exists() and id.where(root='2.16.840.1.113883.4.6').exists() and name.exists()))should-telecom: SHOULD contain telecom ( telecom.exists()) |
| 44. Author.assignedAuthor.representedOrganization.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Short | A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician |
| Comments | The representedOrganization, if present, MAY contain zero or one [0..1] @nullFlavor (CONF:4515-35). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor |
| 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 |
| 46. Author.assignedAuthor.representedOrganization.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 representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-28) such that it. The representedOrganization, if present, SHALL contain at least one [1..*] id (CONF:4515-32981). 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 | 0..*1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IIid |
| Is Modifier | false |
| Slicing | This element introduces a set of slices on Author.assignedAuthor.representedOrganization.id. The slices are unordered and Open, and can be differentiated using the following discriminators: |
| 48. Author.assignedAuthor.representedOrganization.id:taxId | |
| Slice Name | taxId |
| 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 representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-24) such that it 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 | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IIid |
| Is Modifier | false |
| 50. Author.assignedAuthor.representedOrganization.id:taxId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Short | If Tax ID Number is unknown, set @nullFlavor to UNK |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor |
| 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 |
| 52. Author.assignedAuthor.representedOrganization.id:taxId.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.2" Tax ID Number (CONF:4515-26). |
| 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.2 |
| 54. Author.assignedAuthor.representedOrganization.id:taxId.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:4515-32982). |
| 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 |
| 56. Author.assignedAuthor.representedOrganization.id:npi | |
| Slice Name | npi |
| 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 representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-28) such that it 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 | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IIid |
| Is Modifier | false |
| 58. Author.assignedAuthor.representedOrganization.id:npi.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Short | If NPI is unknown, set @nullFlavor to UNK |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor |
| 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 |
| 60. Author.assignedAuthor.representedOrganization.id:npi.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4515-30). |
| 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 |
| 62. Author.assignedAuthor.representedOrganization.id:npi.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | SHOULD contain zero or one [0..1] @extension (CONF:4515-31). |
| 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 |
| 64. Author.assignedAuthor.representedOrganization.name | |
| Definition | A name associated with the organization. |
| Short | Name used for the organization |
| Comments | The representedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4515-11). 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 | 0..1 This element is affected by the following invariants: org-1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ONstring |
| 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())) |
| 66. Author.assignedAuthor.representedOrganization.telecom | |
| Comments | The representedOrganization, if present, SHOULD contain zero or more [0..*] telecom (CONF:4515-12). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
Guidance on how to interpret the contents of this table can be found here
| 0. Author | |
| Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. |
| Short | Base for all types and resources |
| Control | 1..1 |
| Is Modifier | false |
| Logical Container | ClinicalDocument (CDA Class) |
| Validation | Instances of this type are validated by templateId |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. 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 CDANullFlavor |
| 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 |
| 4. 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 |
| 6. 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 |
| 8. Author.typeId.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 CDANullFlavor |
| 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. Author.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| 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 |
| 12. Author.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| 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 |
| 14. Author.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| 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 |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 16. Author.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| 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 |
| 18. 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 | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on Author.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: |
| 20. Author.templateId:provenance-author | |
| Slice Name | provenance-author |
| Definition | When valued in an instance, this attribute 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 | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 22. Author.templateId:provenance-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 CDANullFlavor |
| 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 |
| 24. Author.templateId:provenance-author.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 |
| 26. Author.templateId:provenance-author.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 |
| 28. Author.templateId:provenance-author.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| 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.5.6 |
| 30. Author.templateId:provenance-author.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| 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 | 2019-10-01 |
| 32. 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 |
| 34. 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 |
| 36. Author.functionCode | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 38. Author.time | |
| Short | (USCDI) Author Time Stamp |
| Comments | SHALL contain exactly one [1..1] time (CONF:4515-32983). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| 40. Author.assignedAuthor | |
| Comments | SHALL contain exactly one [1..1] assignedAuthor (CONF:4515-32975). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor |
| Invariants | author-details: Authors require addr, telecom, and either assignedPerson/name or assignedAuthoringDevice/manufacturerModelName. These may be present on this author or on another instance of an Author Participation in the document that has an id that matches the first id of this author. (nullFlavor.exists() or (addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())) or (%resource.descendants().ofType(CDA.AssignedAuthor).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists()))))4515-64: If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64). ( representedOrganization.exists() or (%resource.descendants().ofType(CDA.Author).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.5.6' and $this.extension = '2019-10-01') and assignedAuthor.representedOrganization.exists() and assignedAuthor.id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))))should-code: SHOULD contain code ( code.exists()) |
| 42. Author.assignedAuthor.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 CDANullFlavor |
| 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 |
| 44. Author.assignedAuthor.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 46. Author.assignedAuthor.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 48. Author.assignedAuthor.typeId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor |
| 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 |
| 50. Author.assignedAuthor.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| 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 |
| 52. Author.assignedAuthor.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| 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 |
| 54. Author.assignedAuthor.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| 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 |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 56. Author.assignedAuthor.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| 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 |
| 58. 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 |
| 60. 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 |
| 62. Author.assignedAuthor.id | |
| Comments | This assignedAuthor SHALL contain exactly one [1..1] id (CONF:4515-20) such that. it This assignedAuthor SHALL contain at least one [1..*] id (CONF:4515-2). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on Author.assignedAuthor.id. The slices are unordered and Open, and can be differentiated using the following discriminators: |
| 64. Author.assignedAuthor.id:npi | |
| Slice Name | npi |
| Comments | This assignedAuthor SHALL contain exactly one [1..1] id (CONF:4515-20) such that it |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 66. Author.assignedAuthor.id:npi.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Short | If NPI is unknown, set @nullFlavor to UNK |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor |
| 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 |
| 68. Author.assignedAuthor.id:npi.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| 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 |
| 70. Author.assignedAuthor.id:npi.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| 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 |
| 72. Author.assignedAuthor.id:npi.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4515-22). |
| 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 |
| 74. Author.assignedAuthor.id:npi.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | SHOULD contain zero or one [0..1] @extension (CONF:4515-23). |
| 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 |
| 76. 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 nameidentifiedBy. |
| 78. 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:4515-32979). |
| Control | 0..1 |
| Binding | For example codes, see v3 Code System RoleCode See additional bindings |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 80. 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 | Required on at least one instance of this author in the document |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| Is Modifier | false |
| Invariants | shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). ( nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))should-use: SHOULD contain @use ( nullFlavor.exists() or use.exists())should-country: SHOULD contain country ( nullFlavor.exists() or item.country.exists())81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) ( item.xmlText.empty())81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ( (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)) |
| 82. Author.assignedAuthor.telecom | |
| Short | Required on at least one instance of this author in the document |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 84. Author.assignedAuthor.assignedPerson | |
| Short | assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Person |
| 86. Author.assignedAuthor.assignedPerson.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor |
| 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 |
| 88. Author.assignedAuthor.assignedPerson.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 90. Author.assignedAuthor.assignedPerson.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 92. Author.assignedAuthor.assignedPerson.typeId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor |
| 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 |
| 94. Author.assignedAuthor.assignedPerson.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| 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 |
| 96. Author.assignedAuthor.assignedPerson.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| 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 |
| 98. Author.assignedAuthor.assignedPerson.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| 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 |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 100. Author.assignedAuthor.assignedPerson.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| 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 |
| 102. 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 |
| 104. 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 |
| 106. 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 |
| 108. Author.assignedAuthor.assignedPerson.name | |
| Comments | The assignedPerson, if present, SHALL contain at least one [1..*] name (CONF:4515-32977). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN |
| Invariants | shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). (nullFlavor.exists() or item.family.count() = 1)should-given: SHOULD contain given ( item.given.exists()) |
| 110. Author.assignedAuthor.assignedPerson.name.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 CDANullFlavor |
| 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 |
| 112. Author.assignedAuthor.assignedPerson.name.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..* |
| Binding | The codes SHALL be taken from CDAEntityNameUse |
| 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 |
| 114. Author.assignedAuthor.assignedPerson.name.item | |
| Definition | A series of items that constitute the name. |
| Control | 1..* |
| Type | http://hl7.org/fhir/StructureDefinition/Base |
| Choice Group | This is a repeating choice group that does not appear directly in the instance |
| Invariants | EN-1: Can only have only one of the possible item elements in each choice ((delimiter | family | given | prefix | suffix | xmlText).count() = 1) |
| 116. Author.assignedAuthor.assignedPerson.name.item.delimiter | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
| 118. Author.assignedAuthor.assignedPerson.name.item.family | |
| Short | Family required |
| Comments | Such names SHALL contain exactly one [1..1] family (CONF:4515-17). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
| 120. Author.assignedAuthor.assignedPerson.name.item.given | |
| Short | SHOULD contain given |
| Comments | Such names SHOULD contain zero or more [0..*] given (CONF:4515-18). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
| 122. Author.assignedAuthor.assignedPerson.name.item.prefix | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
| 124. Author.assignedAuthor.assignedPerson.name.item.suffix | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
| 126. Author.assignedAuthor.assignedPerson.name.item.xmlText | |
| Short | Allows for mixed text content |
| Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
| 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. |
| 128. Author.assignedAuthor.assignedPerson.name.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/cda/stds/core/StructureDefinition/IVL-TS |
| Label | Valid Time |
| 130. Author.assignedAuthor.assignedPerson.sdtcDesc | |
| Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document. |
| 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 namedesc. |
| 132. Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship | |
| Definition | Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element. |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship. |
| 134. Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor |
| 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 |
| 136. Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 138. Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 140. Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor |
| 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 |
| 142. Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| 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 |
| 144. Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| 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 |
| 146. Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| 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 |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 148. Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| 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 |
| 150. Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 152. Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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. |
| Fixed Value | PRS |
| 154. Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.determinerCode | |
| 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 | INSTANCE |
| 156. Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.code | |
| Control | 1..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. |
| 158. Author.assignedAuthor.assignedAuthoringDevice | |
| Comments | This assignedAuthor MAY contain zero or one [0..1] assignedAuthoringDevice (CONF:4515-32). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice |
| 160. Author.assignedAuthor.representedOrganization | |
| Short | (USCDI) Author Organization - If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (See - CONF:4440-64). |
| Comments | This assignedAuthor MAY contain zero or one [0..1] representedOrganization (CONF:4515-32978). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| Invariants | provenance-org-details: If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. (nullFlavor = 'NA' or (id.where(root='2.16.840.1.113883.4.2').exists() and id.where(root='2.16.840.1.113883.4.6').exists() and name.exists()))should-telecom: SHOULD contain telecom ( telecom.exists()) |
| 162. Author.assignedAuthor.representedOrganization.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Short | A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician |
| Comments | The representedOrganization, if present, MAY contain zero or one [0..1] @nullFlavor (CONF:4515-35). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor |
| 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 |
| 164. Author.assignedAuthor.representedOrganization.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 |
| 166. Author.assignedAuthor.representedOrganization.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 |
| 168. Author.assignedAuthor.representedOrganization.typeId.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 CDANullFlavor |
| 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 |
| 170. Author.assignedAuthor.representedOrganization.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| 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 |
| 172. Author.assignedAuthor.representedOrganization.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| 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 |
| 174. Author.assignedAuthor.representedOrganization.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| 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 |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 176. Author.assignedAuthor.representedOrganization.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| 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 |
| 178. Author.assignedAuthor.representedOrganization.templateId | |
| Definition | When valued in an instance, this attribute 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 |
| 180. Author.assignedAuthor.representedOrganization.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 |
| 182. Author.assignedAuthor.representedOrganization.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 |
| 184. Author.assignedAuthor.representedOrganization.id | |
| Comments | The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-28) such that it. The representedOrganization, if present, SHALL contain at least one [1..*] id (CONF:4515-32981). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on Author.assignedAuthor.representedOrganization.id. The slices are unordered and Open, and can be differentiated using the following discriminators: |
| 186. Author.assignedAuthor.representedOrganization.id:taxId | |
| Slice Name | taxId |
| Comments | The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-24) such that it |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 188. Author.assignedAuthor.representedOrganization.id:taxId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Short | If Tax ID Number is unknown, set @nullFlavor to UNK |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor |
| 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 |
| 190. Author.assignedAuthor.representedOrganization.id:taxId.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 |
| 192. Author.assignedAuthor.representedOrganization.id:taxId.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 |
| 194. Author.assignedAuthor.representedOrganization.id:taxId.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.2" Tax ID Number (CONF:4515-26). |
| 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.2 |
| 196. Author.assignedAuthor.representedOrganization.id:taxId.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:4515-32982). |
| 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 |
| 198. Author.assignedAuthor.representedOrganization.id:npi | |
| Slice Name | npi |
| Comments | The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-28) such that it |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 200. Author.assignedAuthor.representedOrganization.id:npi.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Short | If NPI is unknown, set @nullFlavor to UNK |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor |
| 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 |
| 202. Author.assignedAuthor.representedOrganization.id:npi.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| 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 |
| 204. Author.assignedAuthor.representedOrganization.id:npi.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| 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 |
| 206. Author.assignedAuthor.representedOrganization.id:npi.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4515-30). |
| 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 |
| 208. Author.assignedAuthor.representedOrganization.id:npi.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | SHOULD contain zero or one [0..1] @extension (CONF:4515-31). |
| 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 |
| 210. Author.assignedAuthor.representedOrganization.name | |
| Comments | The representedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4515-11). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ON |
| 212. Author.assignedAuthor.representedOrganization.telecom | |
| Comments | The representedOrganization, if present, SHOULD contain zero or more [0..*] telecom (CONF:4515-12). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 214. Author.assignedAuthor.representedOrganization.addr | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
| 216. Author.assignedAuthor.representedOrganization.standardIndustryClassCode | |
| Control | 0..1 |
| Binding | For example codes, see OrganizationIndustryClassNAICS |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 218. Author.assignedAuthor.representedOrganization.asOrganizationPartOf | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#3.0.0-ballot based on FHIR 5.0.0. Generated 2023-12-21
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change