Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build
United States of America
Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build
United States of America
This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions 
| Active as of 2023-01-16 |
Definitions for the 2.16.840.1.113883.10.20.22.4.119 resource profile.
Guidance on how to interpret the contents of this table can be found here.
| 1. Author | |
| 2. Author.templateId | |
| 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:
|
| 3. Author.templateId:primary | |
| SliceName | primary |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] templateId (CONF:1098-32017) such that it |
| 4. Author.templateId:primary.root | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.119" (CONF:1098-32018). |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.119 |
| 5. Author.time | |
| Requirements | SHALL contain exactly one [1..1] time (CONF:1098-31471). |
| 6. Author.assignedAuthor | |
| Requirements | SHALL contain exactly one [1..1] assignedAuthor (CONF:1098-31472). |
| 7. Author.assignedAuthor.id | |
| Control | 1..* |
| Requirements | This assignedAuthor SHALL contain at least one [1..*] id (CONF:1098-31473). |
| Invariants | Defined on this element 1098-32628: If the ID isn't referencing an author described elsewhere in the document, then the author components required in US Realm Header are required here as well (CONF:1098-32628). (: null) |
| 8. Author.assignedAuthor.code | |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy |
| Requirements | This assignedAuthor SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1098-31671). |
| Invariants | Defined on this element 1098-32315: If the content is patient authored the code **SHOULD** be selected from Personal And Legal Relationship Role Type (2.16.840.1.113883.11.20.12.1) (CONF:1098-32315). (: null) |
| 9. Author.assignedAuthor.assignedPerson | |
| Control | 0..1 |
| Requirements | This assignedAuthor MAY contain zero or one [0..1] assignedPerson (CONF:1098-31474). |
| 10. Author.assignedAuthor.assignedPerson.name | |
| Control | 0..* |
| Requirements | The assignedPerson, if present, MAY contain zero or more [0..*] name (CONF:1098-31475). |
| 11. Author.assignedAuthor.representedOrganization | |
| Control | 0..1 |
| Requirements | This assignedAuthor MAY contain zero or one [0..1] representedOrganization (CONF:1098-31476). |
| 12. Author.assignedAuthor.representedOrganization.id | |
| Control | 0..* |
| Requirements | The representedOrganization, if present, MAY contain zero or more [0..*] id (CONF:1098-31478). |
| 13. Author.assignedAuthor.representedOrganization.name | |
| Control | 0..* |
| Requirements | The representedOrganization, if present, MAY contain zero or more [0..*] name (CONF:1098-31479). |
| 14. Author.assignedAuthor.representedOrganization.telecom | |
| Control | 0..* |
| Requirements | The representedOrganization, if present, MAY contain zero or more [0..*] telecom (CONF:1098-31480). |
| 15. Author.assignedAuthor.representedOrganization.addr | |
| Control | 0..* |
| Requirements | The representedOrganization, if present, MAY contain zero or more [0..*] addr (CONF:1098-31481). |
Guidance on how to interpret the contents of this table can be found here.
| 1. Author | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 10..1* |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 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 | 0..* |
| Type | http://hl7.org/fhir/cda/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:
|
| 3. Author.templateId:primary | |
| SliceName | primary |
| 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/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain exactly one [1..1] templateId (CONF:1098-32017) such that it |
| 4. Author.templateId:primary.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.119" (CONF:1098-32018). |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.119 |
| 5. Author.time | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| Requirements | SHALL contain exactly one [1..1] time (CONF:1098-31471). |
| 6. Author.assignedAuthor | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedAuthor |
| Requirements | SHALL contain exactly one [1..1] assignedAuthor (CONF:1098-31472). |
| 7. Author.assignedAuthor.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAssignedEntity |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| Fixed Value | ASSIGNED |
| 8. Author.assignedAuthor.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This assignedAuthor SHALL contain at least one [1..*] id (CONF:1098-31473). |
| Invariants | Defined on this element 1098-32628: If the ID isn't referencing an author described elsewhere in the document, then the author components required in US Realm Header are required here as well (CONF:1098-32628). (: null) |
| 9. Author.assignedAuthor.code | |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This assignedAuthor SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1098-31671). |
| Invariants | Defined on this element 1098-32315: If the content is patient authored the code **SHOULD** be selected from Personal And Legal Relationship Role Type (2.16.840.1.113883.11.20.12.1) (CONF:1098-32315). (: null) |
| 10. Author.assignedAuthor.assignedPerson | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
| Requirements | This assignedAuthor MAY contain zero or one [0..1] assignedPerson (CONF:1098-31474). |
| 11. Author.assignedAuthor.assignedPerson.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 12. Author.assignedAuthor.assignedPerson.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 13. Author.assignedAuthor.assignedPerson.name | |
| Definition | A name associated with the person. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ENHumanName |
| Requirements | The assignedPerson, if present, MAY contain zero or more [0..*] name (CONF:1098-31475). Need to be able to track the person by multiple names. Examples are your official name and a partner name. |
| Comments | Person may have multiple names with different uses or applicable periods. |
| 14. Author.assignedAuthor.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organization |
| Requirements | This assignedAuthor MAY contain zero or one [0..1] representedOrganization (CONF:1098-31476). |
| 15. Author.assignedAuthor.representedOrganization.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassOrganization |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ORG |
| Fixed Value | ORG |
| 16. Author.assignedAuthor.representedOrganization.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 17. 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. |
| Control | 0..*1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IIid |
| Requirements | The representedOrganization, if present, MAY contain zero or more [0..*] id (CONF:1098-31478). |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| 18. Author.assignedAuthor.representedOrganization.name | |
| Definition | A name associated with the organization. |
| Control | 0..*1 This element is affected by the following invariants: org-1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ONstring |
| Requirements | The representedOrganization, if present, MAY contain zero or more [0..*] name (CONF:1098-31479). Need to use the name as the label of the organization. |
| Comments | 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. |
| 19. Author.assignedAuthor.representedOrganization.telecom | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| Requirements | The representedOrganization, if present, MAY contain zero or more [0..*] telecom (CONF:1098-31480). |
| 20. Author.assignedAuthor.representedOrganization.addr | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD |
| Requirements | The representedOrganization, if present, MAY contain zero or more [0..*] addr (CONF:1098-31481). |
Guidance on how to interpret the contents of this table can be found here.
| 1. Author | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| 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 NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 3. Author.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | AUT |
| 4. Author.contextControlCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | OP |
| 5. 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/fhir/cda/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/fhir/cda/StructureDefinition/II |
| 7. Author.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/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:
|
| 8. Author.templateId:primary | |
| SliceName | primary |
| 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/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain exactly one [1..1] templateId (CONF:1098-32017) such that it |
| 9. Author.templateId:primary.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. |
| 10. Author.templateId:primary.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 11. Author.templateId:primary.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 12. Author.templateId:primary.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.119" (CONF:1098-32018). |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.119 |
| 13. Author.templateId:primary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 14. Author.functionCode | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 15. Author.time | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| Requirements | SHALL contain exactly one [1..1] time (CONF:1098-31471). |
| 16. Author.assignedAuthor | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedAuthor |
| Requirements | SHALL contain exactly one [1..1] assignedAuthor (CONF:1098-31472). |
| 17. Author.assignedAuthor.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassAssignedEntity |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ASSIGNED |
| Fixed Value | ASSIGNED |
| 18. 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/fhir/cda/StructureDefinition/II |
| 19. Author.assignedAuthor.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | This assignedAuthor SHALL contain at least one [1..*] id (CONF:1098-31473). |
| Invariants | Defined on this element 1098-32628: If the ID isn't referencing an author described elsewhere in the document, then the author components required in US Realm Header are required here as well (CONF:1098-32628). (: ) |
| 20. Author.assignedAuthor.sdtcIdentifiedBy | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy. |
| 21. Author.assignedAuthor.code | |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| Requirements | This assignedAuthor SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1098-31671). |
| Invariants | Defined on this element 1098-32315: If the content is patient authored the code **SHOULD** be selected from Personal And Legal Relationship Role Type (2.16.840.1.113883.11.20.12.1) (CONF:1098-32315). (: ) |
| 22. Author.assignedAuthor.addr | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD |
| 23. Author.assignedAuthor.telecom | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 24. Author.assignedAuthor.assignedPerson | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
| Requirements | This assignedAuthor MAY contain zero or one [0..1] assignedPerson (CONF:1098-31474). |
| 25. Author.assignedAuthor.assignedPerson.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 26. Author.assignedAuthor.assignedPerson.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 27. 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/fhir/cda/StructureDefinition/II |
| 28. Author.assignedAuthor.assignedPerson.name | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/EN |
| Requirements | The assignedPerson, if present, MAY contain zero or more [0..*] name (CONF:1098-31475). |
| 29. Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name asPatientRelationship. |
| 30. Author.assignedAuthor.assignedAuthoringDevice | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AuthoringDevice |
| 31. Author.assignedAuthor.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organization |
| Requirements | This assignedAuthor MAY contain zero or one [0..1] representedOrganization (CONF:1098-31476). |
| 32. Author.assignedAuthor.representedOrganization.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassOrganization |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | ORG |
| Fixed Value | ORG |
| 33. Author.assignedAuthor.representedOrganization.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 34. 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/fhir/cda/StructureDefinition/II |
| 35. Author.assignedAuthor.representedOrganization.id | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | The representedOrganization, if present, MAY contain zero or more [0..*] id (CONF:1098-31478). |
| 36. Author.assignedAuthor.representedOrganization.name | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ON |
| Requirements | The representedOrganization, if present, MAY contain zero or more [0..*] name (CONF:1098-31479). |
| 37. Author.assignedAuthor.representedOrganization.telecom | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| Requirements | The representedOrganization, if present, MAY contain zero or more [0..*] telecom (CONF:1098-31480). |
| 38. Author.assignedAuthor.representedOrganization.addr | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD |
| Requirements | The representedOrganization, if present, MAY contain zero or more [0..*] addr (CONF:1098-31481). |
| 39. Author.assignedAuthor.representedOrganization.standardIndustryClassCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from OrganizationIndustryClassNAICS; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 40. Author.assignedAuthor.representedOrganization.asOrganizationPartOf | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/OrganizationPartOf |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1.0-draft1 based on FHIR 5.0.0-snapshot3. Generated 2023-01-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change