This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) generated with FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions
Active as of 2023-01-16 |
Definitions for the 2.16.840.1.113883.10.20.6.2.1 resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. Performer1 | |
2. Performer1.typeCode | |
Control | 10..1 |
Requirements | SHALL contain exactly one [1..1] @typeCode="PRF" Performer (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8424). |
Pattern Value | PRF |
3. Performer1.templateId | |
Control | 10..1* |
Requirements | SHALL contain exactly one [1..1] templateId (CONF:1098-30773). |
4. Performer1.templateId.root | |
Control | 1..1 |
Requirements | This templateId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.6.2.1" (CONF:1098-30774). |
Pattern Value | 2.16.840.1.113883.10.20.6.2.1 |
5. Performer1.templateId.extension | |
Control | 1..1 |
Requirements | This templateId SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32564). |
Pattern Value | 2014-06-09 |
6. Performer1.time | |
Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS(USRealmDateandTimeDTUSFIELDED) |
Requirements | MAY contain zero or one [0..1] US Realm Date and Time (DT.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:1098-8425). |
7. Performer1.assignedEntity | |
Requirements | SHALL contain exactly one [1..1] assignedEntity (CONF:1098-8426). |
Invariants | Defined on this element 1098-8429: Every assignedEntity element **SHALL** contain at least one [1..*] assignedPerson or representedOrganization (CONF:1098-8429). (: null) 1098-32135: The id **SHOULD** include zero or one [0..1] *id* where id/@root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1098-32135). (: null) |
8. Performer1.assignedEntity.id | |
Control | 1..* |
Requirements | This assignedEntity SHALL contain at least one [1..*] id (CONF:1098-10033). |
9. Performer1.assignedEntity.code | |
Control | 1..1 |
Requirements | This assignedEntity SHALL contain exactly one [1..1] code (CONF:1098-8427). |
Invariants | Defined on this element 1098-8428: **SHALL** contain a valid DICOM personal identification code sequence (@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) (CONF:1098-8428). (: null) |
Guidance on how to interpret the contents of this table can be found here.
1. Performer1 | |
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. Performer1.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ParticipationType |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Requirements | SHALL contain exactly one [1..1] @typeCode="PRF" Performer (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8424). |
Fixed Value | DOC |
Pattern Value | PRF |
3. Performer1.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..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
Requirements | SHALL contain exactly one [1..1] templateId (CONF:1098-30773). |
4. Performer1.templateId.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 | This templateId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.6.2.1" (CONF:1098-30774). |
Pattern Value | 2.16.840.1.113883.10.20.6.2.1 |
5. Performer1.templateId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Requirements | This templateId SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32564). |
Pattern Value | 2014-06-09 |
6. Performer1.time | |
Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS(USRealmDateandTimeDTUSFIELDED) |
Requirements | MAY contain zero or one [0..1] US Realm Date and Time (DT.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:1098-8425). |
Invariants | Defined on this element 81-10078: **SHALL** be precise to the day (CONF:81-10078). (: null) 81-10079: **SHOULD** be precise to the minute (CONF:81-10079). (: null) 81-10080: **MAY** be precise to the second (CONF:81-10080). (: null) 81-10081: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10081). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
7. Performer1.assignedEntity | |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
Requirements | SHALL contain exactly one [1..1] assignedEntity (CONF:1098-8426). |
Invariants | Defined on this element 1098-8429: Every assignedEntity element **SHALL** contain at least one [1..*] assignedPerson or representedOrganization (CONF:1098-8429). (: null) 1098-32135: The id **SHOULD** include zero or one [0..1] *id* where id/@root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1098-32135). (: null) |
8. Performer1.assignedEntity.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 |
9. Performer1.assignedEntity.id | |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
Requirements | This assignedEntity SHALL contain at least one [1..*] id (CONF:1098-10033). |
10. Performer1.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-8427). |
Invariants | Defined on this element 1098-8428: **SHALL** contain a valid DICOM personal identification code sequence (@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) (CONF:1098-8428). (: null) |
Guidance on how to interpret the contents of this table can be found here.
1. Performer1 | |
Definition | Base definition for all types defined in FHIR type system. |
Control | 1..1 |
2. Performer1.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. Performer1.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ParticipationType |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Requirements | SHALL contain exactly one [1..1] @typeCode="PRF" Performer (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8424). |
Fixed Value | DOC |
Pattern Value | PRF |
4. Performer1.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. Performer1.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. Performer1.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..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
Requirements | SHALL contain exactly one [1..1] templateId (CONF:1098-30773). |
7. Performer1.templateId.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. |
8. Performer1.templateId.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. |
9. Performer1.templateId.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. |
10. Performer1.templateId.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 | This templateId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.6.2.1" (CONF:1098-30774). |
Pattern Value | 2.16.840.1.113883.10.20.6.2.1 |
11. Performer1.templateId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Requirements | This templateId SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32564). |
Pattern Value | 2014-06-09 |
12. Performer1.functionCode | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
13. Performer1.time | |
Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS(USRealmDateandTimeDTUSFIELDED) |
Requirements | MAY contain zero or one [0..1] US Realm Date and Time (DT.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:1098-8425). |
Invariants | Defined on this element 81-10078: **SHALL** be precise to the day (CONF:81-10078). (: ) 81-10079: **SHOULD** be precise to the minute (CONF:81-10079). (: ) 81-10080: **MAY** be precise to the second (CONF:81-10080). (: ) 81-10081: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10081). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
14. Performer1.assignedEntity | |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
Requirements | SHALL contain exactly one [1..1] assignedEntity (CONF:1098-8426). |
Invariants | Defined on this element 1098-8429: Every assignedEntity element **SHALL** contain at least one [1..*] assignedPerson or representedOrganization (CONF:1098-8429). (: ) 1098-32135: The id **SHOULD** include zero or one [0..1] *id* where id/@root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1098-32135). (: ) |
15. Performer1.assignedEntity.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 |
16. Performer1.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. Performer1.assignedEntity.id | |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
Requirements | This assignedEntity SHALL contain at least one [1..*] id (CONF:1098-10033). |
18. Performer1.assignedEntity.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 . |
19. Performer1.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-8427). |
Invariants | Defined on this element 1098-8428: **SHALL** contain a valid DICOM personal identification code sequence (@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) (CONF:1098-8428). (: ) |
20. Performer1.assignedEntity.addr | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/AD |
21. Performer1.assignedEntity.telecom | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
22. Performer1.assignedEntity.assignedPerson | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
23. Performer1.assignedEntity.representedOrganization | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Organization |