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 AssessmentScaleObservation 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" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4515-14434). |
Fixed Value | OBS |
4. Observation.moodCode | |
Comments | SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:4515-14435). |
Fixed Value | EVN |
6. Observation.templateId | |
Comments | SHALL contain exactly one [1..1] templateId (CONF:4515-14436) such that it |
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: |
8. Observation.templateId:templateId1 | |
Slice Name | templateId1 |
Short | templateId |
Control | 1..1 |
10. Observation.templateId:templateId1.root | |
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.69" (CONF:4515-14437). |
Control | 1..? |
Pattern Value | 2.16.840.1.113883.10.20.22.4.69 |
12. Observation.templateId:templateId1.extension | |
Comments | SHALL contain exactly one [1..1] @extension="2022-06-01" (CONF:4515-33037). |
Control | 1..? |
Pattern Value | 2022-06-01 |
14. Observation.id | |
Comments | SHALL contain at least one [1..*] id (CONF:4515-14438). |
Control | 1..? |
16. Observation.code | |
Comments | SHALL contain exactly one [1..1] code, which SHALL be selected from CodeSystem LOINC (urn:oid:2.16.840.1.113883.6.1) DYNAMIC (CONF:4515-14439). |
18. Observation.derivationExpr | |
Comments | MAY contain zero or one [0..1] derivationExpr (CONF:4515-14637). |
20. Observation.statusCode | |
Comments | SHALL contain exactly one [1..1] statusCode (CONF:4515-14444). |
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:4515-19088). |
Control | 1..? |
Fixed Value | completed |
24. Observation.effectiveTime | |
Comments | SHALL contain exactly one [1..1] effectiveTime (CONF:4515-14445). |
Control | 1..? |
26. Observation.value | |
Comments | SHALL contain exactly one [1..1] value (CONF:4515-14450). |
Control | 1..1 |
28. Observation.interpretationCode | |
Comments | MAY contain zero or more [0..*] interpretationCode (CONF:4515-14459). |
30. Observation.interpretationCode.translation | |
Comments | The interpretationCode, if present, MAY contain zero or more [0..*] translation (CONF:4515-14888). |
32. Observation.author | |
Comments | MAY contain zero or more [0..*] author (CONF:4515-14460). |
34. Observation.entryRelationship | |
Comments | SHOULD contain zero or more [0..*] entryRelationship (CONF:4515-14451) such that it |
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: |
36. Observation.entryRelationship:entryRelationship1 | |
Slice Name | entryRelationship1 |
Short | entryRelationship |
Control | 0..* |
38. Observation.entryRelationship:entryRelationship1.typeCode | |
Comments | SHALL contain exactly one [1..1] @typeCode="COMP" has component (CONF:4515-16741). |
Fixed Value | COMP |
40. Observation.entryRelationship:entryRelationship1.observation | |
Comments | SHALL contain exactly one [1..1] Assessment Scale Supporting Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.86) (CONF:4515-16742). |
Control | 1..? |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Assessment Scale Supporting Observation) |
42. Observation.referenceRange | |
Comments | MAY contain zero or more [0..*] referenceRange (CONF:4515-16799). |
44. Observation.referenceRange.observationRange | |
Comments | The referenceRange, if present, SHALL contain exactly one [1..1] observationRange (CONF:4515-16800). |
46. Observation.referenceRange.observationRange.text | |
Comments | This observationRange SHOULD contain zero or one [0..1] text (CONF:4515-16801). |
48. Observation.referenceRange.observationRange.text.reference | |
Comments | The text, if present, SHOULD contain zero or one [0..1] reference (CONF:4515-16802). |
50. Observation.referenceRange.observationRange.text.reference.value | |
Comments | The reference, if present, MAY contain zero or one [0..1] @value (CONF:4515-16803). |
Invariants | 4515-16804: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:4515-16804). () |
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" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4515-14434). |
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" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:4515-14435). |
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.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 |
Comments | SHALL contain exactly one [1..1] templateId (CONF:4515-14436) such that it |
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: |
8. Observation.templateId:templateId1 | |
Slice Name | templateId1 |
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 |
Short | templateId |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
10. Observation.templateId:templateId1.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.69" (CONF:4515-14437). |
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.69 |
12. Observation.templateId:templateId1.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Comments | SHALL contain exactly one [1..1] @extension="2022-06-01" (CONF:4515-33037). |
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 | 2022-06-01 |
14. 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:4515-14438). 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 |
16. 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 SHALL be selected from CodeSystem LOINC (urn:oid:2.16.840.1.113883.6.1) DYNAMIC (CONF:4515-14439). 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 | Unless not suitable, these codes SHALL be taken from For example codes, see ObservationTypehttp://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:type attribute. |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Alternate Names | Name |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. Observation.derivationExpr | |
Comments | MAY contain zero or one [0..1] derivationExpr (CONF:4515-14637). |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ST |
20. Observation.statusCode | |
Comments | SHALL contain exactly one [1..1] statusCode (CONF:4515-14444). |
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:4515-19088). |
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:type attribute. |
Label | Translation |
38. Observation.effectiveTime | |
Comments | SHALL contain exactly one [1..1] effectiveTime (CONF:4515-14445). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
40. Observation.value | |
Comments | SHALL contain exactly one [1..1] value (CONF:4515-14450). |
Control | 1..1 |
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/ANY, http://hl7.org/cda/stds/core/StructureDefinition/BL, http://hl7.org/cda/stds/core/StructureDefinition/ED, http://hl7.org/cda/stds/core/StructureDefinition/ST, http://hl7.org/cda/stds/core/StructureDefinition/CD, http://hl7.org/cda/stds/core/StructureDefinition/CV, http://hl7.org/cda/stds/core/StructureDefinition/CE, http://hl7.org/cda/stds/core/StructureDefinition/SC, http://hl7.org/cda/stds/core/StructureDefinition/II, http://hl7.org/cda/stds/core/StructureDefinition/TEL, http://hl7.org/cda/stds/core/StructureDefinition/AD, http://hl7.org/cda/stds/core/StructureDefinition/EN, http://hl7.org/cda/stds/core/StructureDefinition/INT, http://hl7.org/cda/stds/core/StructureDefinition/REAL, http://hl7.org/cda/stds/core/StructureDefinition/PQ, http://hl7.org/cda/stds/core/StructureDefinition/MO, http://hl7.org/cda/stds/core/StructureDefinition/TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS, http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ |
XML Format | The type of this property is determined using the xsi:type attribute. |
42. Observation.interpretationCode | |
Comments | MAY contain zero or more [0..*] interpretationCode (CONF:4515-14459). |
Control | 0..* |
Binding | The codes SHALL be taken from ObservationInterpretation |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
44. Observation.interpretationCode.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 |
46. Observation.interpretationCode.translation | |
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
Comments | The interpretationCode, if present, MAY contain zero or more [0..*] translation (CONF:4515-14888). |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Translation |
48. Observation.author | |
Comments | MAY contain zero or more [0..*] author (CONF:4515-14460). |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
50. Observation.entryRelationship | |
Comments | SHOULD contain zero or more [0..*] entryRelationship (CONF:4515-14451) such that it |
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: |
52. Observation.entryRelationship:entryRelationship1 | |
Slice Name | entryRelationship1 |
Short | entryRelationship |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
54. Observation.entryRelationship:entryRelationship1.typeCode | |
Comments | SHALL contain exactly one [1..1] @typeCode="COMP" has component (CONF:4515-16741). |
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 | COMP |
56. Observation.entryRelationship:entryRelationship1.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] Assessment Scale Supporting Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.86) (CONF:4515-16742). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Assessment Scale Supporting Observation) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
58. Observation.referenceRange | |
Definition | Relates an Observation to the ObservationRange class, where the expected range of values for a particular observation can be specified. Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two |
Short | Provides guide for interpretation |
Comments | MAY contain zero or more [0..*] referenceRange (CONF:4515-16799). Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRootBackboneElement |
Is Modifier | false |
Requirements | Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) obs-3: Must have at least a low or a high or text (low.exists() or high.exists() or text.exists()) |
60. Observation.referenceRange.observationRange | |
Comments | The referenceRange, if present, SHALL contain exactly one [1..1] observationRange (CONF:4515-16800). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationRange |
62. Observation.referenceRange.observationRange.classCode | |
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. |
Default Value | OBS |
64. Observation.referenceRange.observationRange.text | |
Comments | This observationRange SHOULD contain zero or one [0..1] text (CONF:4515-16801). |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
66. Observation.referenceRange.observationRange.text.reference | |
Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
Comments | The text, if present, SHOULD contain zero or one [0..1] reference (CONF:4515-16802). |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
Label | Reference |
68. Observation.referenceRange.observationRange.text.reference.value | |
Comments | The reference, if present, MAY contain zero or one [0..1] @value (CONF:4515-16803). |
Control | 0..1 |
Type | url(url: Universal Resource Locator) |
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. |
Invariants | 4515-16804: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:4515-16804). () |
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" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4515-14434). |
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" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:4515-14435). |
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 | |
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 |
Comments | SHALL contain exactly one [1..1] templateId (CONF:4515-14436) such that it |
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:templateId1 | |
Slice Name | templateId1 |
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 |
Short | templateId |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
16. Observation.templateId:templateId1.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:templateId1.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:templateId1.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:templateId1.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.69" (CONF:4515-14437). |
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.69 |
24. Observation.templateId:templateId1.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Comments | SHALL contain exactly one [1..1] @extension="2022-06-01" (CONF:4515-33037). |
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 | 2022-06-01 |
26. Observation.id | |
Comments | SHALL contain at least one [1..*] id (CONF:4515-14438). |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
28. Observation.code | |
Comments | SHALL contain exactly one [1..1] code, which SHALL be selected from CodeSystem LOINC (urn:oid:2.16.840.1.113883.6.1) DYNAMIC (CONF:4515-14439). |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from ObservationType |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
XML Format | The type of this property is determined using the xsi:type attribute. |
30. Observation.derivationExpr | |
Comments | MAY contain zero or one [0..1] derivationExpr (CONF:4515-14637). |
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:type attribute. |
34. Observation.statusCode | |
Comments | SHALL contain exactly one [1..1] statusCode (CONF:4515-14444). |
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:4515-19088). |
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:type attribute. |
Label | Translation |
58. Observation.effectiveTime | |
Comments | SHALL contain exactly one [1..1] effectiveTime (CONF:4515-14445). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
60. 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 |
62. Observation.repeatNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT |
64. Observation.languageCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from HumanLanguage |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
66. Observation.value | |
Comments | SHALL contain exactly one [1..1] value (CONF:4515-14450). |
Control | 1..1 |
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/ANY, http://hl7.org/cda/stds/core/StructureDefinition/BL, http://hl7.org/cda/stds/core/StructureDefinition/ED, http://hl7.org/cda/stds/core/StructureDefinition/ST, http://hl7.org/cda/stds/core/StructureDefinition/CD, http://hl7.org/cda/stds/core/StructureDefinition/CV, http://hl7.org/cda/stds/core/StructureDefinition/CE, http://hl7.org/cda/stds/core/StructureDefinition/SC, http://hl7.org/cda/stds/core/StructureDefinition/II, http://hl7.org/cda/stds/core/StructureDefinition/TEL, http://hl7.org/cda/stds/core/StructureDefinition/AD, http://hl7.org/cda/stds/core/StructureDefinition/EN, http://hl7.org/cda/stds/core/StructureDefinition/INT, http://hl7.org/cda/stds/core/StructureDefinition/REAL, http://hl7.org/cda/stds/core/StructureDefinition/PQ, http://hl7.org/cda/stds/core/StructureDefinition/MO, http://hl7.org/cda/stds/core/StructureDefinition/TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS, http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ |
XML Format | The type of this property is determined using the xsi:type attribute. |
68. Observation.interpretationCode | |
Comments | MAY contain zero or more [0..*] interpretationCode (CONF:4515-14459). |
Control | 0..* |
Binding | The codes SHALL be taken from ObservationInterpretation |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
70. Observation.interpretationCode.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 |
72. Observation.interpretationCode.code | |
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code |
74. Observation.interpretationCode.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 |
76. Observation.interpretationCode.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 |
78. Observation.interpretationCode.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 |
80. Observation.interpretationCode.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 |
82. Observation.interpretationCode.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 . |
84. Observation.interpretationCode.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 . |
86. Observation.interpretationCode.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 |
88. Observation.interpretationCode.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 |
90. Observation.interpretationCode.translation | |
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
Comments | The interpretationCode, if present, MAY contain zero or more [0..*] translation (CONF:4515-14888). |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Translation |
92. Observation.methodCode | |
Control | 0..* |
Binding | Unless not suitable, these codes SHALL be taken from ObservationMethod |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
94. Observation.targetSiteCode | |
Definition | Drawn from concept domain ActSite |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
96. Observation.subject | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
98. Observation.specimen | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
100. Observation.performer | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
102. Observation.author | |
Comments | MAY contain zero or more [0..*] author (CONF:4515-14460). |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
104. Observation.informant | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
106. Observation.participant | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
108. Observation.entryRelationship | |
Comments | SHOULD contain zero or more [0..*] entryRelationship (CONF:4515-14451) such that it |
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: |
110. Observation.entryRelationship:entryRelationship1 | |
Slice Name | entryRelationship1 |
Short | entryRelationship |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
112. Observation.entryRelationship:entryRelationship1.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 |
114. Observation.entryRelationship:entryRelationship1.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 |
116. Observation.entryRelationship:entryRelationship1.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 |
118. Observation.entryRelationship:entryRelationship1.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 |
120. Observation.entryRelationship:entryRelationship1.typeCode | |
Comments | SHALL contain exactly one [1..1] @typeCode="COMP" has component (CONF:4515-16741). |
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 | COMP |
122. Observation.entryRelationship:entryRelationship1.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. |
124. Observation.entryRelationship:entryRelationship1.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 |
126. Observation.entryRelationship:entryRelationship1.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. |
128. Observation.entryRelationship:entryRelationship1.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
130. Observation.entryRelationship:entryRelationship1.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
132. Observation.entryRelationship:entryRelationship1.act | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
134. Observation.entryRelationship:entryRelationship1.encounter | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
136. Observation.entryRelationship:entryRelationship1.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] Assessment Scale Supporting Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.86) (CONF:4515-16742). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Assessment Scale Supporting Observation) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
138. Observation.entryRelationship:entryRelationship1.observationMedia | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
140. Observation.entryRelationship:entryRelationship1.organizer | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
142. Observation.entryRelationship:entryRelationship1.procedure | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
144. Observation.entryRelationship:entryRelationship1.regionOfInterest | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
146. Observation.entryRelationship:entryRelationship1.substanceAdministration | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
148. Observation.entryRelationship:entryRelationship1.supply | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
150. Observation.reference | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
152. Observation.precondition | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
154. Observation.referenceRange | |
Definition | Relates an Observation to the ObservationRange class, where the expected range of values for a particular observation can be specified. |
Comments | MAY contain zero or more [0..*] referenceRange (CONF:4515-16799). |
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()) ) |
156. 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 |
158. 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 |
160. 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 |
162. 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 |
164. 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 |
166. Observation.referenceRange.observationRange | |
Comments | The referenceRange, if present, SHALL contain exactly one [1..1] observationRange (CONF:4515-16800). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationRange |
168. Observation.referenceRange.observationRange.classCode | |
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. |
Default Value | OBS |
170. Observation.referenceRange.observationRange.moodCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ActMoodPredicate |
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.CRT |
172. Observation.referenceRange.observationRange.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 |
174. Observation.referenceRange.observationRange.code | |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System ActCode |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
176. Observation.referenceRange.observationRange.text | |
Comments | This observationRange SHOULD contain zero or one [0..1] text (CONF:4515-16801). |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
178. Observation.referenceRange.observationRange.text.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 |
180. Observation.referenceRange.observationRange.text.charset | |
Definition | For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []. |
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 | Charset |
182. Observation.referenceRange.observationRange.text.compression | |
Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
Control | 0..1 |
Binding | The codes SHALL be taken from CompressionAlgorithm |
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 | Compression |
184. Observation.referenceRange.observationRange.text.integrityCheck | |
Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
Control | 0..1 |
Type | base64Binary(bin: Binary Data) |
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 | Integrity Check |
186. Observation.referenceRange.observationRange.text.integrityCheckAlgorithm | |
Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
Control | 0..1 |
Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
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 | Integrity Check Algorithm |
188. Observation.referenceRange.observationRange.text.language | |
Definition | For character based information the language property specifies the human language of the text. |
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 | Language |
190. Observation.referenceRange.observationRange.text.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
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 | Media Type |
192. Observation.referenceRange.observationRange.text.representation | |
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. |
194. Observation.referenceRange.observationRange.text.data[x] | |
Definition | Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.) |
Control | 0..1 |
Type | Choice of: string(st: Character String), base64Binary(bin: Binary Data) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
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 unadorned text. |
196. Observation.referenceRange.observationRange.text.reference | |
Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
Comments | The text, if present, SHOULD contain zero or one [0..1] reference (CONF:4515-16802). |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
Label | Reference |
198. Observation.referenceRange.observationRange.text.reference.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 |
200. Observation.referenceRange.observationRange.text.reference.value | |
Comments | The reference, if present, MAY contain zero or one [0..1] @value (CONF:4515-16803). |
Control | 0..1 |
Type | url(url: Universal Resource Locator) |
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. |
Invariants | 4515-16804: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:4515-16804). () |
202. Observation.referenceRange.observationRange.text.reference.useablePeriod | |
Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address. |
Control | 0..* |
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Useable Period |
204. Observation.referenceRange.observationRange.text.reference.use | |
Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
Control | 0..* |
Binding | The codes SHALL be taken from AddressUse |
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 | Use Code |
206. Observation.referenceRange.observationRange.text.thumbnail | |
Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
Label | Thumbnail |
208. Observation.referenceRange.observationRange.value | |
Control | 0..1 |
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/BL, http://hl7.org/cda/stds/core/StructureDefinition/ED, http://hl7.org/cda/stds/core/StructureDefinition/ST, http://hl7.org/cda/stds/core/StructureDefinition/CD, http://hl7.org/cda/stds/core/StructureDefinition/CV, http://hl7.org/cda/stds/core/StructureDefinition/CE, http://hl7.org/cda/stds/core/StructureDefinition/SC, http://hl7.org/cda/stds/core/StructureDefinition/II, http://hl7.org/cda/stds/core/StructureDefinition/TEL, http://hl7.org/cda/stds/core/StructureDefinition/AD, http://hl7.org/cda/stds/core/StructureDefinition/EN, http://hl7.org/cda/stds/core/StructureDefinition/INT, http://hl7.org/cda/stds/core/StructureDefinition/REAL, http://hl7.org/cda/stds/core/StructureDefinition/PQ, http://hl7.org/cda/stds/core/StructureDefinition/MO, http://hl7.org/cda/stds/core/StructureDefinition/TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
XML Format | The type of this property is determined using the xsi:type attribute. |
210. Observation.referenceRange.observationRange.interpretationCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ObservationInterpretation |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |