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.6.2.2 resource profile.
1. EncounterParticipant | |
Control | 1..1 |
2. EncounterParticipant.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. EncounterParticipant.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ParticipationType |
Type | code |
Requirements | SHALL contain exactly one [1..1] @typeCode="ATND" Attender (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1098-8881). |
Pattern Value | ATND |
4. EncounterParticipant.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 |
5. EncounterParticipant.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 |
6. EncounterParticipant.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 EncounterParticipant.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
7. EncounterParticipant.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-16072) such that it |
8. EncounterParticipant.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 |
9. EncounterParticipant.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 |
10. EncounterParticipant.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 |
11. EncounterParticipant.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.6.2.2" (CONF:1098-16073). |
Pattern Value | 2.16.840.1.113883.10.20.6.2.2 |
12. EncounterParticipant.templateId:primary.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string |
Requirements | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32586). |
Pattern Value | 2014-06-09 |
13. EncounterParticipant.time | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
14. EncounterParticipant.assignedEntity | |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
Requirements | SHALL contain exactly one [1..1] assignedEntity (CONF:1098-8886). |
15. EncounterParticipant.assignedEntity.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from RoleClassAssignedEntity |
Type | code |
Default Value | ASSIGNED |
Fixed Value | ASSIGNED |
16. EncounterParticipant.assignedEntity.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
17. EncounterParticipant.assignedEntity.id | |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
Requirements | This assignedEntity SHALL contain at least one [1..*] id (CONF:1098-8887). |
Invariants | Defined on this element 1098-31203: **SHOULD** contain zero or one [0..1] *id* such that *@root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1098-31203). (: ) |
18. EncounterParticipant.assignedEntity.sdtcIdentifiedBy | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy |
19. EncounterParticipant.assignedEntity.code | |
Control | 1..1 |
Binding | The codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
Requirements | This assignedEntity SHALL contain exactly one [1..1] code (CONF:1098-8888). |
Invariants | Defined on this element 1098-8889: **SHALL** contain a valid DICOM Organizational Role from DICOM CID 7452 (Value Set 1.2.840.10008.6.1.516) (@codeSystem is 1.2.840.10008.2.16.4) or an appropriate national health care provider coding system (e.g., NUCC in the U.S., where @codeSystem is 2.16.840.1.113883.6.101). Footnote: DICOM Part 16 (NEMA PS3.16), page 631 in the 2011 edition. See [URL:ftp://medical.nema.org/medical/dicom/2011/11_16pu.pdf] (CONF:1098-8889). (: ) |
20. EncounterParticipant.assignedEntity.addr | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/AD |
21. EncounterParticipant.assignedEntity.telecom | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
22. EncounterParticipant.assignedEntity.assignedPerson | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
Requirements | This assignedEntity SHOULD contain zero or one [0..1] assignedPerson (CONF:1098-30928). |
23. EncounterParticipant.assignedEntity.assignedPerson.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from EntityClassLivingSubject |
Type | code |
Default Value | PSN |
Fixed Value | PSN |
24. EncounterParticipant.assignedEntity.assignedPerson.determinerCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from EntityDeterminer |
Type | code |
Default Value | INSTANCE |
Fixed Value | INSTANCE |
25. EncounterParticipant.assignedEntity.assignedPerson.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
26. EncounterParticipant.assignedEntity.assignedPerson.name | |
Definition | A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status). |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED) |
Requirements | The assignedPerson, if present, SHALL contain exactly one [1..1] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1098-30929). |
Invariants | Defined on this element 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (: ) 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: ) |
27. EncounterParticipant.assignedEntity.assignedPerson.sdtcAsPatientRelationship | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
28. EncounterParticipant.assignedEntity.representedOrganization | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Organization |
Requirements | This assignedEntity MAY contain zero or one [0..1] representedOrganization (CONF:1098-16074). |
29. EncounterParticipant.assignedEntity.representedOrganization.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from EntityClassOrganization |
Type | code |
Default Value | ORG |
Fixed Value | ORG |
30. EncounterParticipant.assignedEntity.representedOrganization.determinerCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from EntityDeterminer |
Type | code |
Default Value | INSTANCE |
Fixed Value | INSTANCE |
31. EncounterParticipant.assignedEntity.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 |
32. EncounterParticipant.assignedEntity.representedOrganization.id | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
33. EncounterParticipant.assignedEntity.representedOrganization.name | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ON |
Requirements | The representedOrganization, if present, SHOULD contain zero or one [0..1] name (CONF:1098-16075). |
34. EncounterParticipant.assignedEntity.representedOrganization.telecom | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
35. EncounterParticipant.assignedEntity.representedOrganization.addr | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/AD |
36. EncounterParticipant.assignedEntity.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 |
37. EncounterParticipant.assignedEntity.representedOrganization.asOrganizationPartOf | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/OrganizationPartOf |