Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions
| Active as of 2022-05-13 |
Definitions for the 2.16.840.1.113883.10.20.22.4.119 resource profile.
| 1. Author | |
| 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 |
| 3. Author.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| Fixed Value | AUT |
| 4. Author.contextControlCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| Default Value | PSN |
| Fixed Value | PSN |
| 26. Author.assignedAuthor.assignedPerson.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| 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 |
| 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 |
| Default Value | ORG |
| Fixed Value | ORG |
| 33. Author.assignedAuthor.representedOrganization.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| 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 |