Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions
| Draft as of 2023-09-29 |
Definitions for the ProblemObservation logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. Observation | |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. Observation.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-9041). |
| Fixed Value | OBS |
| 4. Observation.moodCode | |
| Comments | SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1198-9042). |
| Fixed Value | EVN |
| 6. Observation.negationInd | |
| Short | The negationInd is used to indicate the absence of the condition in observation/value. A negationInd of "true" coupled with an observation/value of SNOMED code 64572001 "Disease (disorder)" indicates that the patient has no known conditions. |
| Comments | MAY contain zero or one [0..1] @negationInd (CONF:1198-10139). |
| 8. Observation.templateId | |
| Control | 1..? |
| Slicing | This element introduces a set of slices on Observation.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 10. Observation.templateId:primary | |
| Slice Name | primary |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:1198-14926) such that it |
| Control | 1..1 |
| 12. Observation.templateId:primary.root | |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.4" (CONF:1198-14927). |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.4 |
| 14. Observation.templateId:primary.extension | |
| Comments | SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32508). |
| Control | 1..? |
| Pattern Value | 2015-08-01 |
| 16. Observation.id | |
| Comments | SHALL contain at least one [1..*] id (CONF:1198-9043). |
| Control | 1..? |
| 18. Observation.code | |
| Comments | SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Problem Type (SNOMEDCT) urn:oid:2.16.840.1.113883.3.88.12.3221.7.2 DYNAMIC (CONF:1198-9045). |
| Binding | The codes SHOULD be taken from Problem Type (SNOMEDCT) |
| Invariants | 1198-32950: If code is selected from ValueSet Problem Type (SNOMEDCT) urn:oid:2.16.840.1.113883.3.88.12.3221.7.2 **DYNAMIC**, then it **SHALL** have at least one [1..*] translation, which **SHOULD** be selected from ValueSet Problem Type (LOINC) urn:oid:2.16.840.1.113762.1.4.1099.28 **DYNAMIC** (CONF:1198-32950) (CONF:1198-32950). () |
| 20. Observation.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:1198-9049). |
| Control | 1..? |
| 22. Observation.statusCode.code | |
| Comments | This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1198-19112). |
| Control | 1..? |
| Fixed Value | completed |
| 24. Observation.effectiveTime | |
| Short | If the problem is known to be resolved, but the date of resolution is not known, then the high element **SHALL** be present, and the nullFlavor attribute **SHALL** be set to 'UNK'. Therefore, the existence of a high element within a problem does indicate that the problem has been resolved. |
| Comments | SHALL contain exactly one [1..1] effectiveTime (CONF:1198-9050). |
| Control | 1..? |
| 26. Observation.effectiveTime.low | |
| Short | The effectiveTime/low (a.k.a. "onset date") asserts when the condition became biologically active. |
| Comments | This effectiveTime SHALL contain exactly one [1..1] low (CONF:1198-15603). |
| Control | 1..? |
| 28. Observation.effectiveTime.high | |
| Short | The effectiveTime/high (a.k.a. "resolution date") asserts when the condition became biologically resolved. |
| Comments | This effectiveTime MAY contain zero or one [0..1] high (CONF:1198-15604). |
| 30. Observation.value | |
| Comments | SHALL contain exactly one [1..1] value with @xsi:type="CD", where the code SHOULD be selected from ValueSet Problem urn:oid:2.16.840.1.113883.3.88.12.3221.7.4 DYNAMIC (CONF:1198-9058). |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from Problem |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/TEL, http://hl7.org/cda/stds/core/StructureDefinition/EN, http://hl7.org/cda/stds/core/StructureDefinition/BL, http://hl7.org/cda/stds/core/StructureDefinition/AD, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS, http://hl7.org/cda/stds/core/StructureDefinition/ED, http://hl7.org/cda/stds/core/StructureDefinition/TS, http://hl7.org/cda/stds/core/StructureDefinition/II, http://hl7.org/cda/stds/core/StructureDefinition/ST, http://hl7.org/cda/stds/core/StructureDefinition/PQ, http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ, http://hl7.org/cda/stds/core/StructureDefinition/CE, http://hl7.org/cda/stds/core/StructureDefinition/MO, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/ANY, http://hl7.org/cda/stds/core/StructureDefinition/INT, http://hl7.org/cda/stds/core/StructureDefinition/REAL, http://hl7.org/cda/stds/core/StructureDefinition/CV, http://hl7.org/cda/stds/core/StructureDefinition/SC |
| 32. Observation.value.code | |
| Short | A negationInd of "true" coupled with an observation/value/@code of SNOMED code 64572001 "Disease (disorder)" indicates that the patient has no known conditions. |
| Comments | This value MAY contain zero or one [0..1] @code (CONF:1198-31871). |
| 34. Observation.value.qualifier | |
| Short | The observation/value and all the qualifiers together (often referred to as a post-coordinated expression) make up one concept. Qualifiers constrain the meaning of the primary code, and cannot negate it or change its meaning. Qualifiers can only be used according to well-defined rules of post-coordination and only if the underlying code system defines the use of such qualifiers or if there is a third code system that specifies how other code systems may be combined. For example, SNOMED CT allows constructing concepts as a combination of multiple codes. SNOMED CT defines a concept "pneumonia (disorder)" (233604007) an attribute "finding site" (363698007) and another concept "left lower lobe of lung (body structure)" (41224006). SNOMED CT allows one to combine these codes in a code phrase, as shown in the sample XML. |
| Comments | This value MAY contain zero or more [0..*] qualifier (CONF:1198-31870). |
| 36. Observation.value.translation | |
| Slicing | This element introduces a set of slices on Observation.value.translation. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 38. Observation.value.translation:alt | |
| Slice Name | alt |
| Comments | This value MAY contain zero or more [0..*] translation (CONF:1198-16749) such that it |
| Control | 0..* |
| 40. Observation.value.translation:alt.code | |
| Comments | MAY contain zero or one [0..1] @code (CodeSystem: ICD-10-CM urn:oid:2.16.840.1.113883.6.90 STATIC) (CONF:1198-16750). |
| 42. Observation.author | |
| Comments | SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1198-31147). |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation) |
| 44. Observation.entryRelationship | |
| Slicing | This element introduces a set of slices on Observation.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 46. Observation.entryRelationship:age | |
| Slice Name | age |
| Comments | MAY contain zero or one [0..1] entryRelationship (CONF:1198-9059) such that it |
| Control | 0..1 |
| 48. Observation.entryRelationship:age.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="SUBJ" Has subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-9060). |
| Fixed Value | SUBJ |
| 50. Observation.entryRelationship:age.inversionInd | |
| Comments | SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1198-9069). |
| Control | 1..? |
| Fixed Value | true |
| 52. Observation.entryRelationship:age.observation | |
| Comments | SHALL contain exactly one [1..1] Age Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.31) (CONF:1198-15590). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Age Observation) |
| 54. Observation.entryRelationship:prognosis | |
| Slice Name | prognosis |
| Comments | MAY contain zero or one [0..1] entryRelationship (CONF:1198-29951) such that it |
| Control | 0..1 |
| 56. Observation.entryRelationship:prognosis.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-31531). |
| Fixed Value | REFR |
| 58. Observation.entryRelationship:prognosis.observation | |
| Comments | SHALL contain exactly one [1..1] Prognosis Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.113) (CONF:1198-29952). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Prognosis Observation) |
| 60. Observation.entryRelationship:priority | |
| Slice Name | priority |
| Comments | MAY contain zero or more [0..*] entryRelationship (CONF:1198-31063) such that it |
| Control | 0..* |
| 62. Observation.entryRelationship:priority.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-31532). |
| Fixed Value | REFR |
| 64. Observation.entryRelationship:priority.observation | |
| Comments | SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1198-31064). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference) |
| 66. Observation.entryRelationship:status | |
| Slice Name | status |
| Comments | MAY contain zero or one [0..1] entryRelationship (CONF:1198-9063) such that it |
| Control | 0..1 |
| 68. Observation.entryRelationship:status.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-9068). |
| Fixed Value | REFR |
| 70. Observation.entryRelationship:status.observation | |
| Comments | SHALL contain exactly one [1..1] Problem Status (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.6:2019-06-20) (CONF:1198-15591). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Problem Status) |
Guidance on how to interpret the contents of this table can be found here
| 0. Observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Control | 10..1* |
| Is Modifier | false |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 2. Observation.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-9041). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClassObservation |
| 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. |
| Fixed Value | OBS |
| 4. Observation.moodCode | |
| Comments | SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1198-9042). |
| 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. |
| Fixed Value | EVN |
| 6. Observation.negationInd | |
| Short | The negationInd is used to indicate the absence of the condition in observation/value. A negationInd of "true" coupled with an observation/value of SNOMED code 64572001 "Disease (disorder)" indicates that the patient has no known conditions. |
| Comments | MAY contain zero or one [0..1] @negationInd (CONF:1198-10139). |
| 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. |
| 8. Observation.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 Observation.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 10. Observation.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 |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:1198-14926) such that it |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 12. Observation.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. |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.4" (CONF:1198-14927). |
| 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 |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.4 |
| 14. Observation.templateId:primary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32508). |
| 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 |
| Pattern Value | 2015-08-01 |
| 16. Observation.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| Comments | SHALL contain at least one [1..*] id (CONF:1198-9043). Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Control | 10..*1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IIid |
| Is Modifier | false |
| 18. Observation.code | |
| Definition | Describes what was observed. Sometimes this is called the observation "name". |
| Short | Type of observation (code / type) |
| Comments | SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Problem Type (SNOMEDCT) urn:oid:2.16.840.1.113883.3.88.12.3221.7.2 DYNAMIC (CONF:1198-9045). All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
| Control | 1..1 This element is affected by the following invariants: obs-7 |
| Binding | The codes SHOULD be taken from For example codes, see Problem Type (SNOMEDCT)http://hl7.org/fhir/ValueSet/observation-codes |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CDCodeableConcept |
| Is Modifier | false |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
| Alternate Names | Name |
| Invariants | 1198-32950: If code is selected from ValueSet Problem Type (SNOMEDCT) urn:oid:2.16.840.1.113883.3.88.12.3221.7.2 **DYNAMIC**, then it **SHALL** have at least one [1..*] translation, which **SHOULD** be selected from ValueSet Problem Type (LOINC) urn:oid:2.16.840.1.113762.1.4.1099.28 **DYNAMIC** (CONF:1198-32950) (CONF:1198-32950). () ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 20. Observation.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:1198-9049). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 22. Observation.statusCode.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. |
| Comments | This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1198-19112). |
| 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. |
| Label | Code |
| Fixed Value | completed |
| 24. Observation.statusCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..0 |
| 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 |
| 26. Observation.statusCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..0 |
| 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 |
| 28. Observation.statusCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..0 |
| 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 |
| 30. Observation.statusCode.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..0 |
| 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 |
| 32. Observation.statusCode.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| Label | Original Text |
| 34. Observation.statusCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
| Label | Qualifier |
| 36. Observation.statusCode.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Label | Translation |
| 38. Observation.effectiveTime | |
| Short | If the problem is known to be resolved, but the date of resolution is not known, then the high element **SHALL** be present, and the nullFlavor attribute **SHALL** be set to 'UNK'. Therefore, the existence of a high element within a problem does indicate that the problem has been resolved. |
| Comments | SHALL contain exactly one [1..1] effectiveTime (CONF:1198-9050). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| 40. Observation.effectiveTime.low | |
| Definition | This is the low limit of the interval. |
| Short | The effectiveTime/low (a.k.a. "onset date") asserts when the condition became biologically active. |
| Comments | This effectiveTime SHALL contain exactly one [1..1] low (CONF:1198-15603). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | Low Boundary |
| 42. Observation.effectiveTime.high | |
| Definition | This is the high limit of the interval. |
| Short | The effectiveTime/high (a.k.a. "resolution date") asserts when the condition became biologically resolved. |
| Comments | This effectiveTime MAY contain zero or one [0..1] high (CONF:1198-15604). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | High Boundary |
| 44. Observation.value | |
| Comments | SHALL contain exactly one [1..1] value with @xsi:type="CD", where the code SHOULD be selected from ValueSet Problem urn:oid:2.16.840.1.113883.3.88.12.3221.7.4 DYNAMIC (CONF:1198-9058). |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from Problem |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| 46. Observation.value.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. |
| Short | A negationInd of "true" coupled with an observation/value/@code of SNOMED code 64572001 "Disease (disorder)" indicates that the patient has no known conditions. |
| Comments | This value MAY contain zero or one [0..1] @code (CONF:1198-31871). |
| 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 |
| 48. Observation.value.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Short | The observation/value and all the qualifiers together (often referred to as a post-coordinated expression) make up one concept. Qualifiers constrain the meaning of the primary code, and cannot negate it or change its meaning. Qualifiers can only be used according to well-defined rules of post-coordination and only if the underlying code system defines the use of such qualifiers or if there is a third code system that specifies how other code systems may be combined. For example, SNOMED CT allows constructing concepts as a combination of multiple codes. SNOMED CT defines a concept "pneumonia (disorder)" (233604007) an attribute "finding site" (363698007) and another concept "left lower lobe of lung (body structure)" (41224006). SNOMED CT allows one to combine these codes in a code phrase, as shown in the sample XML. |
| Comments | This value MAY contain zero or more [0..*] qualifier (CONF:1198-31870). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
| Label | Qualifier |
| 50. Observation.value.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:typeattribute. |
| Label | Translation |
| Slicing | This element introduces a set of slices on Observation.value.translation. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 52. Observation.value.translation:alt | |
| Slice Name | alt |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Comments | This value MAY contain zero or more [0..*] translation (CONF:1198-16749) such that it |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Label | Translation |
| 54. Observation.value.translation:alt.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. |
| Comments | MAY contain zero or one [0..1] @code (CodeSystem: ICD-10-CM urn:oid:2.16.840.1.113883.6.90 STATIC) (CONF:1198-16750). |
| 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 |
| 56. Observation.author | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1198-31147). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 58. Observation.entryRelationship | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| Slicing | This element introduces a set of slices on Observation.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 60. Observation.entryRelationship:age | |
| Slice Name | age |
| Comments | MAY contain zero or one [0..1] entryRelationship (CONF:1198-9059) such that it |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 62. Observation.entryRelationship:age.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="SUBJ" Has subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-9060). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship |
| 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. |
| Fixed Value | SUBJ |
| 64. Observation.entryRelationship:age.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. |
| Comments | SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1198-9069). |
| Control | 1..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. |
| Fixed Value | true |
| 66. Observation.entryRelationship:age.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | SHALL contain exactly one [1..1] Age Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.31) (CONF:1198-15590). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Age Observation) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 68. Observation.entryRelationship:prognosis | |
| Slice Name | prognosis |
| Comments | MAY contain zero or one [0..1] entryRelationship (CONF:1198-29951) such that it |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 70. Observation.entryRelationship:prognosis.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-31531). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship |
| 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. |
| Fixed Value | REFR |
| 72. Observation.entryRelationship:prognosis.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | SHALL contain exactly one [1..1] Prognosis Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.113) (CONF:1198-29952). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Prognosis Observation) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 74. Observation.entryRelationship:priority | |
| Slice Name | priority |
| Comments | MAY contain zero or more [0..*] entryRelationship (CONF:1198-31063) such that it |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 76. Observation.entryRelationship:priority.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-31532). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship |
| 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. |
| Fixed Value | REFR |
| 78. Observation.entryRelationship:priority.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1198-31064). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 80. Observation.entryRelationship:status | |
| Slice Name | status |
| Comments | MAY contain zero or one [0..1] entryRelationship (CONF:1198-9063) such that it |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 82. Observation.entryRelationship:status.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-9068). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship |
| 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. |
| Fixed Value | REFR |
| 84. Observation.entryRelationship:status.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | SHALL contain exactly one [1..1] Problem Status (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.6:2019-06-20) (CONF:1198-15591). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Problem Status) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
| 0. Observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Control | 1..1 |
| Is Modifier | false |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 2. Observation.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-9041). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClassObservation |
| 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. |
| Fixed Value | OBS |
| 4. Observation.moodCode | |
| Comments | SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1198-9042). |
| 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. |
| Fixed Value | EVN |
| 6. Observation.negationInd | |
| Short | The negationInd is used to indicate the absence of the condition in observation/value. A negationInd of "true" coupled with an observation/value of SNOMED code 64572001 "Disease (disorder)" indicates that the patient has no known conditions. |
| Comments | MAY contain zero or one [0..1] @negationInd (CONF:1198-10139). |
| 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. |
| 8. Observation.realmCode | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 10. Observation.typeId | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 12. Observation.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 Observation.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 14. Observation.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 |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:1198-14926) such that it |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 16. Observation.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(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 |
| 18. Observation.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 |
| 20. Observation.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 |
| 22. Observation.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. |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.4" (CONF:1198-14927). |
| 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 |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.4 |
| 24. Observation.templateId:primary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32508). |
| 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 |
| Pattern Value | 2015-08-01 |
| 26. Observation.id | |
| Comments | SHALL contain at least one [1..*] id (CONF:1198-9043). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 28. Observation.code | |
| Comments | SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Problem Type (SNOMEDCT) urn:oid:2.16.840.1.113883.3.88.12.3221.7.2 DYNAMIC (CONF:1198-9045). |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from Problem Type (SNOMEDCT) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Invariants | 1198-32950: If code is selected from ValueSet Problem Type (SNOMEDCT) urn:oid:2.16.840.1.113883.3.88.12.3221.7.2 **DYNAMIC**, then it **SHALL** have at least one [1..*] translation, which **SHOULD** be selected from ValueSet Problem Type (LOINC) urn:oid:2.16.840.1.113762.1.4.1099.28 **DYNAMIC** (CONF:1198-32950) (CONF:1198-32950). () |
| 30. Observation.derivationExpr | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ST |
| 32. Observation.text | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| 34. Observation.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:1198-9049). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 36. Observation.statusCode.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(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 |
| 38. Observation.statusCode.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. |
| Comments | This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1198-19112). |
| 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. |
| Label | Code |
| Fixed Value | completed |
| 40. Observation.statusCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..0 |
| 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 |
| 42. Observation.statusCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..0 |
| 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 |
| 44. Observation.statusCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..0 |
| 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 |
| 46. Observation.statusCode.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..0 |
| 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 |
| 48. Observation.statusCode.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. |
| 50. Observation.statusCode.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. |
| 52. Observation.statusCode.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| Label | Original Text |
| 54. Observation.statusCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
| Label | Qualifier |
| 56. Observation.statusCode.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Label | Translation |
| 58. Observation.effectiveTime | |
| Short | If the problem is known to be resolved, but the date of resolution is not known, then the high element **SHALL** be present, and the nullFlavor attribute **SHALL** be set to 'UNK'. Therefore, the existence of a high element within a problem does indicate that the problem has been resolved. |
| Comments | SHALL contain exactly one [1..1] effectiveTime (CONF:1198-9050). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| 60. Observation.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 NullFlavor |
| 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 |
| 62. Observation.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 | string(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. |
| 64. Observation.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 SetOperator |
| 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 |
| 66. Observation.effectiveTime.low | |
| Definition | This is the low limit of the interval. |
| Short | The effectiveTime/low (a.k.a. "onset date") asserts when the condition became biologically active. |
| Comments | This effectiveTime SHALL contain exactly one [1..1] low (CONF:1198-15603). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | Low Boundary |
| 68. Observation.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 |
| 70. Observation.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 |
| 72. Observation.effectiveTime.high | |
| Definition | This is the high limit of the interval. |
| Short | The effectiveTime/high (a.k.a. "resolution date") asserts when the condition became biologically resolved. |
| Comments | This effectiveTime MAY contain zero or one [0..1] high (CONF:1198-15604). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | High Boundary |
| 74. Observation.priorityCode | |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ActPriority |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 76. Observation.repeatNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT |
| 78. Observation.languageCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from HumanLanguage |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 80. Observation.value | |
| Comments | SHALL contain exactly one [1..1] value with @xsi:type="CD", where the code SHOULD be selected from ValueSet Problem urn:oid:2.16.840.1.113883.3.88.12.3221.7.4 DYNAMIC (CONF:1198-9058). |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from Problem |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| 82. Observation.value.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(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 |
| 84. Observation.value.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. |
| Short | A negationInd of "true" coupled with an observation/value/@code of SNOMED code 64572001 "Disease (disorder)" indicates that the patient has no known conditions. |
| Comments | This value MAY contain zero or one [0..1] @code (CONF:1198-31871). |
| 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 |
| 86. Observation.value.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 |
| 88. Observation.value.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 |
| 90. Observation.value.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 |
| 92. Observation.value.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 |
| 94. Observation.value.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. |
| 96. Observation.value.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. |
| 98. Observation.value.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 |
| 100. Observation.value.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Short | The observation/value and all the qualifiers together (often referred to as a post-coordinated expression) make up one concept. Qualifiers constrain the meaning of the primary code, and cannot negate it or change its meaning. Qualifiers can only be used according to well-defined rules of post-coordination and only if the underlying code system defines the use of such qualifiers or if there is a third code system that specifies how other code systems may be combined. For example, SNOMED CT allows constructing concepts as a combination of multiple codes. SNOMED CT defines a concept "pneumonia (disorder)" (233604007) an attribute "finding site" (363698007) and another concept "left lower lobe of lung (body structure)" (41224006). SNOMED CT allows one to combine these codes in a code phrase, as shown in the sample XML. |
| Comments | This value MAY contain zero or more [0..*] qualifier (CONF:1198-31870). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
| Label | Qualifier |
| 102. Observation.value.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:typeattribute. |
| Label | Translation |
| Slicing | This element introduces a set of slices on Observation.value.translation. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 104. Observation.value.translation:alt | |
| Slice Name | alt |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Comments | This value MAY contain zero or more [0..*] translation (CONF:1198-16749) such that it |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Label | Translation |
| 106. Observation.value.translation:alt.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(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 |
| 108. Observation.value.translation:alt.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. |
| Comments | MAY contain zero or one [0..1] @code (CodeSystem: ICD-10-CM urn:oid:2.16.840.1.113883.6.90 STATIC) (CONF:1198-16750). |
| 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 |
| 110. Observation.value.translation:alt.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 |
| 112. Observation.value.translation:alt.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 |
| 114. Observation.value.translation:alt.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 |
| 116. Observation.value.translation:alt.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 |
| 118. Observation.value.translation:alt.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. |
| 120. Observation.value.translation:alt.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. |
| 122. Observation.value.translation:alt.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 |
| 124. Observation.value.translation:alt.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 |
| 126. Observation.value.translation:alt.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:typeattribute. |
| Label | Translation |
| 128. Observation.interpretationCode | |
| Control | 0..* |
| Binding | The codes SHALL be taken from ObservationInterpretation |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 130. Observation.methodCode | |
| Control | 0..* |
| Binding | Unless not suitable, these codes SHALL be taken from ObservationMethod |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 132. Observation.targetSiteCode | |
| Definition | Drawn from concept domain ActSite |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| 134. Observation.subject | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
| 136. Observation.specimen | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
| 138. Observation.performer | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
| 140. Observation.author | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1198-31147). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 142. Observation.informant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
| 144. Observation.participant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
| 146. Observation.entryRelationship | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| Slicing | This element introduces a set of slices on Observation.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 148. Observation.entryRelationship:age | |
| Slice Name | age |
| Comments | MAY contain zero or one [0..1] entryRelationship (CONF:1198-9059) such that it |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 150. Observation.entryRelationship:age.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(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 |
| 152. Observation.entryRelationship:age.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 |
| 154. Observation.entryRelationship:age.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 |
| 156. Observation.entryRelationship:age.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 |
| 158. Observation.entryRelationship:age.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="SUBJ" Has subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-9060). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship |
| 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. |
| Fixed Value | SUBJ |
| 160. Observation.entryRelationship:age.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. |
| Comments | SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1198-9069). |
| Control | 1..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. |
| Fixed Value | true |
| 162. Observation.entryRelationship:age.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 |
| 164. Observation.entryRelationship:age.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. |
| 166. Observation.entryRelationship:age.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 168. Observation.entryRelationship:age.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 170. Observation.entryRelationship:age.act | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
| 172. Observation.entryRelationship:age.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
| 174. Observation.entryRelationship:age.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | SHALL contain exactly one [1..1] Age Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.31) (CONF:1198-15590). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Age Observation) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 176. Observation.entryRelationship:age.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
| 178. Observation.entryRelationship:age.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
| 180. Observation.entryRelationship:age.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
| 182. Observation.entryRelationship:age.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
| 184. Observation.entryRelationship:age.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
| 186. Observation.entryRelationship:age.supply | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
| 188. Observation.entryRelationship:prognosis | |
| Slice Name | prognosis |
| Comments | MAY contain zero or one [0..1] entryRelationship (CONF:1198-29951) such that it |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 190. Observation.entryRelationship:prognosis.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(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 |
| 192. Observation.entryRelationship:prognosis.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 |
| 194. Observation.entryRelationship:prognosis.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 |
| 196. Observation.entryRelationship:prognosis.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 |
| 198. Observation.entryRelationship:prognosis.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-31531). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship |
| 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. |
| Fixed Value | REFR |
| 200. Observation.entryRelationship:prognosis.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(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. |
| 202. Observation.entryRelationship:prognosis.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 |
| 204. Observation.entryRelationship:prognosis.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. |
| 206. Observation.entryRelationship:prognosis.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 208. Observation.entryRelationship:prognosis.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 210. Observation.entryRelationship:prognosis.act | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
| 212. Observation.entryRelationship:prognosis.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
| 214. Observation.entryRelationship:prognosis.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | SHALL contain exactly one [1..1] Prognosis Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.113) (CONF:1198-29952). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Prognosis Observation) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 216. Observation.entryRelationship:prognosis.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
| 218. Observation.entryRelationship:prognosis.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
| 220. Observation.entryRelationship:prognosis.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
| 222. Observation.entryRelationship:prognosis.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
| 224. Observation.entryRelationship:prognosis.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
| 226. Observation.entryRelationship:prognosis.supply | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
| 228. Observation.entryRelationship:priority | |
| Slice Name | priority |
| Comments | MAY contain zero or more [0..*] entryRelationship (CONF:1198-31063) such that it |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 230. Observation.entryRelationship:priority.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(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 |
| 232. Observation.entryRelationship:priority.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 |
| 234. Observation.entryRelationship:priority.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 |
| 236. Observation.entryRelationship:priority.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 |
| 238. Observation.entryRelationship:priority.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-31532). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship |
| 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. |
| Fixed Value | REFR |
| 240. Observation.entryRelationship:priority.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(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. |
| 242. Observation.entryRelationship:priority.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 |
| 244. Observation.entryRelationship:priority.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. |
| 246. Observation.entryRelationship:priority.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 248. Observation.entryRelationship:priority.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 250. Observation.entryRelationship:priority.act | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
| 252. Observation.entryRelationship:priority.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
| 254. Observation.entryRelationship:priority.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1198-31064). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 256. Observation.entryRelationship:priority.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
| 258. Observation.entryRelationship:priority.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
| 260. Observation.entryRelationship:priority.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
| 262. Observation.entryRelationship:priority.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
| 264. Observation.entryRelationship:priority.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
| 266. Observation.entryRelationship:priority.supply | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
| 268. Observation.entryRelationship:status | |
| Slice Name | status |
| Comments | MAY contain zero or one [0..1] entryRelationship (CONF:1198-9063) such that it |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 270. Observation.entryRelationship:status.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(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 |
| 272. Observation.entryRelationship:status.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 |
| 274. Observation.entryRelationship:status.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 |
| 276. Observation.entryRelationship:status.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 |
| 278. Observation.entryRelationship:status.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-9068). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship |
| 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. |
| Fixed Value | REFR |
| 280. Observation.entryRelationship:status.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(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. |
| 282. Observation.entryRelationship:status.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 |
| 284. Observation.entryRelationship:status.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. |
| 286. Observation.entryRelationship:status.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 288. Observation.entryRelationship:status.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 290. Observation.entryRelationship:status.act | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
| 292. Observation.entryRelationship:status.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
| 294. Observation.entryRelationship:status.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | SHALL contain exactly one [1..1] Problem Status (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.6:2019-06-20) (CONF:1198-15591). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Problem Status) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 296. Observation.entryRelationship:status.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
| 298. Observation.entryRelationship:status.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
| 300. Observation.entryRelationship:status.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
| 302. Observation.entryRelationship:status.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
| 304. Observation.entryRelationship:status.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
| 306. Observation.entryRelationship:status.supply | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
| 308. Observation.reference | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
| 310. Observation.precondition | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
| 312. Observation.referenceRange | |
| Definition | Relates an Observation to the ObservationRange class, where the expected range of values for a particular observation can be specified. |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 314. Observation.referenceRange.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(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 |
| 316. Observation.referenceRange.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 |
| 318. Observation.referenceRange.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 |
| 320. Observation.referenceRange.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 |
| 322. Observation.referenceRange.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActRelationshipPertains |
| 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. |
| Fixed Value | REFV |
| 324. Observation.referenceRange.observationRange | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationRange |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1 based on FHIR 5.0.0. Generated 2023-09-29
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change