International Patient Summary (IPS), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 1.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-IPS/ and changes regularly. See the Directory of published versions
Draft as of 2024-08-04 |
Definitions for the 2.16.840.1.113883.10.22.4.5--20240804100924 logical model.
Guidance on how to interpret the contents of this table can be found here
0. Act | |
Control | 0..* |
Must Support | true |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. Act.templateId | |
Control | 1..? |
Slicing | This element introduces a set of slices on Act.templateId . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
4. Act.templateId:primary | |
Slice Name | primary |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Must Support | true |
6. Act.templateId:primary.root | |
Control | 1..1 |
Type | 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. |
Fixed Value | 2.16.840.1.113883.10.22.4.5 |
8. Act.classCode | |
Control | 1..1 |
Type | code |
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. |
Fixed Value | ACT |
10. Act.moodCode | |
Control | 1..1 |
Type | code |
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. |
Fixed Value | EVN |
12. Act.id | |
Control | 0..* |
Must Support | true |
14. Act.code | |
Control | 1..1 |
Must Support | true |
16. Act.code.code | |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CONC |
18. Act.code.codeSystem | |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | 2.16.840.1.113883.5.6 |
20. Act.statusCode | |
Definition | As long as the underlying conditions are of concern to the author (i.e., as long as allergies, whether active or resolved, is of ongoing concern and interest to the author), the statusCode is “ active ”. The concern is tracked by the author. Only when the underlying allergies are no longer of concern then the statusCode is set to “ completed ”. The author is no more tracking this concern and no further actions are expected. |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActStatusActiveComplete (required to http://terminology.hl7.org/ValueSet/v3-xActStatusActiveComplete )x_ActStatusActiveComplete |
Must Support | true |
22. Act.effectiveTime | |
Control | 1..1 |
Must Support | true |
24. Act.effectiveTime.low | |
Definition | This element asserts when the concern became active. This equates to the time the concern was authored in the patient's chart and the author started tracking this concern. |
Control | 1..1 |
Must Support | true |
26. Act.effectiveTime.high | |
Definition | This element asserts when the clinician deemed there is no longer any need to track the underlying conditions.If statusCode/@code="completed" Completed, then effectiveTime SHALL contain [1..1] high |
Control | 0..1 This element is affected by the following invariants: MD1557037N1l27l352l30l19l10l12 |
Invariants | MD1557037N1l27l352l30l19l10l12: If statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high () |
28. Act.entryRelationship | |
Control | 1..? |
Slicing | This element introduces a set of slices on Act.entryRelationship . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
30. Act.entryRelationship:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Control | 1..* |
Must Support | true |
Invariants | entryRelationship-1: contains IPS Allergy or Intolerance 2.16.840.1.113883.10.22.4.1 (2024-08-04) () |
32. Act.entryRelationship:entryRelationship-1.typeCode | |
Control | 1..1 |
Type | code |
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. |
Fixed Value | SUBJ |
34. Act.entryRelationship:entryRelationship-1.inversionInd | |
Control | 0..1 |
Type | 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. |
Fixed Value | false |
36. Act.entryRelationship:entryRelationship-1.observation | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(IPS Allergy or Intolerance) |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here
0. Act | |
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 | 0..* |
Is Modifier | false |
Must Support | true |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. Act.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..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Slicing | This element introduces a set of slices on Act.templateId . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
4. Act.templateId:primary | |
Slice Name | 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/cda/stds/core/StructureDefinition/II |
Must Support | true |
6. Act.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 |
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.10.22.4.5 |
8. Act.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from XActClassDocumentEntryAct (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 ) |
Type | code |
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. |
Fixed Value | ACT |
10. Act.moodCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from XDocumentActMood (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 ) |
Type | code |
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. |
Fixed Value | EVN |
12. Act.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Must Support | true |
14. Act.code | |
Control | 1..1 |
Binding | For example codes, see v3 Code System ActCode (example to http://terminology.hl7.org/ValueSet/v3-ActCode ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
Must Support | true |
16. Act.code.code | |
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
Control | 0..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. |
Label | Code |
Fixed Value | CONC |
18. Act.code.codeSystem | |
Definition | Specifies the code system that defines the code. |
Control | 0..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 | Code System |
Fixed Value | 2.16.840.1.113883.5.6 |
20. Act.statusCode | |
Definition | As long as the underlying conditions are of concern to the author (i.e., as long as allergies, whether active or resolved, is of ongoing concern and interest to the author), the statusCode is “ active ”. The concern is tracked by the author. Only when the underlying allergies are no longer of concern then the statusCode is set to “ completed ”. The author is no more tracking this concern and no further actions are expected. |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActStatusActiveComplete (required to http://terminology.hl7.org/ValueSet/v3-xActStatusActiveComplete )x_ActStatusActiveComplete |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
Must Support | true |
22. Act.effectiveTime | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
Must Support | true |
24. Act.effectiveTime.low | |
Definition | This element asserts when the concern became active. This equates to the time the concern was authored in the patient's chart and the author started tracking this concern. |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
Must Support | true |
Label | Low Boundary |
26. Act.effectiveTime.high | |
Definition | This element asserts when the clinician deemed there is no longer any need to track the underlying conditions.If statusCode/@code="completed" Completed, then effectiveTime SHALL contain [1..1] high |
Control | 0..1 This element is affected by the following invariants: MD1557037N1l27l352l30l19l10l12 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
Label | High Boundary |
Invariants | MD1557037N1l27l352l30l19l10l12: If statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high () |
28. Act.entryRelationship | |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Slicing | This element introduces a set of slices on Act.entryRelationship . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
30. Act.entryRelationship:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Must Support | true |
Invariants | entryRelationship-1: contains IPS Allergy or Intolerance 2.16.840.1.113883.10.22.4.1 (2024-08-04) () |
32. Act.entryRelationship:entryRelationship-1.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship ) |
Type | code |
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. |
Fixed Value | SUBJ |
34. Act.entryRelationship:entryRelationship-1.inversionInd | |
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed. |
Control | 0..1 |
Type | 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. |
Fixed Value | false |
36. Act.entryRelationship:entryRelationship-1.observation | |
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 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(IPS Allergy or Intolerance) |
Is Modifier | false |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here
0. Act | |
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 | 0..* |
Is Modifier | false |
Must Support | true |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. Act.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 (required to http://hl7.org/cda/stds/core/ValueSet/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. Act.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. Act.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. Act.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 (required to http://hl7.org/cda/stds/core/ValueSet/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. Act.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. Act.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. Act.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. Act.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. Act.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..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Slicing | This element introduces a set of slices on Act.templateId . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
20. Act.templateId:primary | |
Slice Name | 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/cda/stds/core/StructureDefinition/II |
Must Support | true |
22. Act.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/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 |
24. Act.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(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 |
26. Act.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(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 |
28. Act.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 |
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.10.22.4.5 |
30. Act.templateId:primary.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
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 | Extension |
32. Act.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from XActClassDocumentEntryAct (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 ) |
Type | code |
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. |
Fixed Value | ACT |
34. Act.moodCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from XDocumentActMood (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 ) |
Type | code |
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. |
Fixed Value | EVN |
36. Act.negationInd | |
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. |
38. Act.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Must Support | true |
40. Act.code | |
Control | 1..1 |
Binding | For example codes, see v3 Code System ActCode (example to http://terminology.hl7.org/ValueSet/v3-ActCode ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
Must Support | true |
42. Act.code.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 (required to http://hl7.org/cda/stds/core/ValueSet/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 |
44. Act.code.code | |
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
Control | 0..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. |
Label | Code |
Fixed Value | CONC |
46. Act.code.codeSystem | |
Definition | Specifies the code system that defines the code. |
Control | 0..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 | Code System |
Fixed Value | 2.16.840.1.113883.5.6 |
48. Act.code.codeSystemName | |
Definition | The common name of the coding system. |
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 | Code System Name |
50. Act.code.codeSystemVersion | |
Definition | If applicable, a version descriptor defined specifically for the given code system. |
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 | Code System Version |
52. Act.code.displayName | |
Definition | A name or title for the code, under which the sending system shows the code value to its users. |
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 | Display Name |
54. Act.code.sdtcValueSet | |
Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
Control | 0..1 |
Type | string(oid: ISO Object Identifier) |
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.In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual namevalueSet . |
56. Act.code.sdtcValueSetVersion | |
Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
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.In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual namevalueSetVersion . |
58. Act.code.originalText | |
Definition | The text or phrase used as the basis for the coding. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
Label | Original Text |
60. Act.code.qualifier | |
Definition | Specifies additional codes that increase the specificity of the the primary code. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
Label | Qualifier |
62. Act.code.translation | |
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Translation |
64. Act.text | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
66. Act.statusCode | |
Definition | As long as the underlying conditions are of concern to the author (i.e., as long as allergies, whether active or resolved, is of ongoing concern and interest to the author), the statusCode is “ active ”. The concern is tracked by the author. Only when the underlying allergies are no longer of concern then the statusCode is set to “ completed ”. The author is no more tracking this concern and no further actions are expected. |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActStatusActiveComplete (required to http://terminology.hl7.org/ValueSet/v3-xActStatusActiveComplete )x_ActStatusActiveComplete |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
Must Support | true |
68. Act.effectiveTime | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
Must Support | true |
70. Act.effectiveTime.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 (required to http://hl7.org/cda/stds/core/ValueSet/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 |
72. Act.effectiveTime.value | |
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 | dateTime(ts: Point in Time) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
XML Format | In the XML format, this property is represented as an attribute. |
74. Act.effectiveTime.operator | |
Definition | A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDASetOperator (required to http://hl7.org/cda/stds/core/ValueSet/CDASetOperator ) |
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 | I |
76. Act.effectiveTime.low | |
Definition | This element asserts when the concern became active. This equates to the time the concern was authored in the patient's chart and the author started tracking this concern. |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
Must Support | true |
Label | Low Boundary |
78. Act.effectiveTime.center | |
Definition | The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
Label | Central Value |
80. Act.effectiveTime.width | |
Definition | The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
Label | Width |
82. Act.effectiveTime.high | |
Definition | This element asserts when the clinician deemed there is no longer any need to track the underlying conditions.If statusCode/@code="completed" Completed, then effectiveTime SHALL contain [1..1] high |
Control | 0..1 This element is affected by the following invariants: MD1557037N1l27l352l30l19l10l12 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
Label | High Boundary |
Invariants | MD1557037N1l27l352l30l19l10l12: If statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high () |
84. Act.priorityCode | |
Control | 0..1 |
Binding | For example codes, see ActPriority (example to http://terminology.hl7.org/ValueSet/v3-ActPriority ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
86. Act.languageCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
88. Act.subject | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
90. Act.specimen | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
92. Act.performer | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
94. Act.author | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
96. Act.informant | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
98. Act.participant | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
100. Act.entryRelationship | |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Slicing | This element introduces a set of slices on Act.entryRelationship . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
102. Act.entryRelationship:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Must Support | true |
Invariants | entryRelationship-1: contains IPS Allergy or Intolerance 2.16.840.1.113883.10.22.4.1 (2024-08-04) () |
104. Act.entryRelationship:entryRelationship-1.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 (required to http://hl7.org/cda/stds/core/ValueSet/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 |
106. Act.entryRelationship:entryRelationship-1.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 |
108. Act.entryRelationship:entryRelationship-1.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 |
110. Act.entryRelationship:entryRelationship-1.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 (required to http://hl7.org/cda/stds/core/ValueSet/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 |
112. Act.entryRelationship:entryRelationship-1.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 |
114. Act.entryRelationship:entryRelationship-1.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 |
116. Act.entryRelationship:entryRelationship-1.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 |
118. Act.entryRelationship:entryRelationship-1.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 |
120. Act.entryRelationship:entryRelationship-1.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 |
122. Act.entryRelationship:entryRelationship-1.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship ) |
Type | code |
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. |
Fixed Value | SUBJ |
124. Act.entryRelationship:entryRelationship-1.inversionInd | |
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed. |
Control | 0..1 |
Type | 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. |
Fixed Value | false |
126. Act.entryRelationship:entryRelationship-1.contextConductionInd | |
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context. |
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. |
Default Value | true |
128. Act.entryRelationship:entryRelationship-1.negationInd | |
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. |
130. Act.entryRelationship:entryRelationship-1.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
132. Act.entryRelationship:entryRelationship-1.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
134. Act.entryRelationship:entryRelationship-1.act | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
136. Act.entryRelationship:entryRelationship-1.encounter | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
138. Act.entryRelationship:entryRelationship-1.observation | |
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 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(IPS Allergy or Intolerance) |
Is Modifier | false |
Must Support | true |
140. Act.entryRelationship:entryRelationship-1.observationMedia | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
142. Act.entryRelationship:entryRelationship-1.organizer | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
144. Act.entryRelationship:entryRelationship-1.procedure | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
146. Act.entryRelationship:entryRelationship-1.regionOfInterest | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
148. Act.entryRelationship:entryRelationship-1.substanceAdministration | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
150. Act.entryRelationship:entryRelationship-1.supply | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
152. Act.reference | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
154. Act.precondition | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
156. Act.sdtcPrecondition2 | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition2 |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual nameprecondition2 . |
158. Act.sdtcInFulfillmentOf1 | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1 |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual nameinFulfillmentOf1 . |