This page is part of the CDA: Clinical Document Architecture (v2.0.0-sd-ballot: CDA 2.0 Ballot 1) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions
Active as of 2023-10-27 |
Definitions for the IntendedRecipient logical model.
Guidance on how to interpret the contents of this table can be found here
0. IntendedRecipient | |
Control | 1..1 |
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. IntendedRecipient.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. |
Default Value | ASSIGNED |
4. IntendedRecipient.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
6. IntendedRecipient.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 . |
8. IntendedRecipient.addr | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
10. IntendedRecipient.telecom | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
12. IntendedRecipient.informationRecipient | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person |
14. IntendedRecipient.receivedOrganization | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
Guidance on how to interpret the contents of this table can be found here
0. IntendedRecipient | |
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 |
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. IntendedRecipient.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. |
Default Value | ASSIGNED |
4. IntendedRecipient.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
6. IntendedRecipient.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 . |
8. IntendedRecipient.addr | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
10. IntendedRecipient.telecom | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
12. IntendedRecipient.informationRecipient | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person |
14. IntendedRecipient.receivedOrganization | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
Guidance on how to interpret the contents of this table can be found here
0. IntendedRecipient | |
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 |
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. IntendedRecipient.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. IntendedRecipient.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. IntendedRecipient.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. IntendedRecipient.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. IntendedRecipient.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. IntendedRecipient.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. IntendedRecipient.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. IntendedRecipient.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. IntendedRecipient.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 |
20. IntendedRecipient.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. |
Default Value | ASSIGNED |
22. IntendedRecipient.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
24. IntendedRecipient.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 . |
26. IntendedRecipient.addr | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
28. IntendedRecipient.telecom | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
30. IntendedRecipient.informationRecipient | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person |
32. IntendedRecipient.receivedOrganization | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |