Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build United States of America

This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) generated with FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: ReactionObservation - Detailed Descriptions

Active as of 2023-01-16

Definitions for the 2.16.840.1.113883.10.20.22.4.9 resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. Observation
2. Observation.classCode
Requirements

SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-7325).

Pattern ValueOBS
3. Observation.moodCode
Requirements

SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-7326).

Pattern ValueEVN
4. Observation.templateId
SlicingThis element introduces a set of slices on Observation.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
5. Observation.templateId:primary
SliceNameprimary
Control1..1
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-7323) such that it

6. Observation.templateId:primary.root
Control1..1
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.9" (CONF:1098-10523).

Pattern Value2.16.840.1.113883.10.20.22.4.9
7. Observation.templateId:primary.extension
Control1..1
Requirements

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32504).

Pattern Value2014-06-09
8. Observation.id
Control10..*
Requirements

SHALL contain at least one [1..*] id (CONF:1098-7329).

9. Observation.code
Requirements

SHALL contain exactly one [1..1] code (CONF:1098-16851).

10. Observation.code.code
Control1..1
Requirements

This code SHALL contain exactly one [1..1] @code="ASSERTION" (CONF:1098-31124).

Pattern ValueASSERTION
11. Observation.code.codeSystem
Control1..1
Requirements

This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.5.4" (CodeSystem: HL7ActCode urn:oid:2.16.840.1.113883.5.4) (CONF:1098-32169).

Pattern Value2.16.840.1.113883.5.4
12. Observation.statusCode
Control10..1
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1098-7328).

13. Observation.statusCode.code
Control1..1
Requirements

This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1098-19114).

Pattern Valuecompleted
14. Observation.effectiveTime
Requirements

SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7332).

15. Observation.effectiveTime.low
Control0..1
Requirements

The effectiveTime, if present, SHOULD contain zero or one [0..1] low (CONF:1098-7333).

16. Observation.effectiveTime.high
Control0..1
Requirements

The effectiveTime, if present, SHOULD contain zero or one [0..1] high (CONF:1098-7334).

17. Observation.value
Control10..1*
BindingThe codes SHALL be taken from ProblemFor codes, see (unbound)
TypeChoice of: , http://hl7.org/fhir/cda/StructureDefinition/ED, http://hl7.org/fhir/cda/StructureDefinition/TS, http://hl7.org/fhir/cda/StructureDefinition/II, http://hl7.org/fhir/cda/StructureDefinition/ST, http://hl7.org/fhir/cda/StructureDefinition/PQ, http://hl7.org/fhir/cda/StructureDefinition/CE, http://hl7.org/fhir/cda/StructureDefinition/TEL, http://hl7.org/fhir/cda/StructureDefinition/MO, http://hl7.org/fhir/cda/StructureDefinition/AD, http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/IVL-PQ, http://hl7.org/fhir/cda/StructureDefinition/EN, http://hl7.org/fhir/cda/StructureDefinition/BL, http://hl7.org/fhir/cda/StructureDefinition/REAL, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SC, http://hl7.org/fhir/cda/StructureDefinition/RTO-PQ-PQ, http://hl7.org/fhir/cda/StructureDefinition/CV, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/INT, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
Requirements

SHALL contain exactly one [1..1] value with @xsi:type="CD", where the code SHALL be selected from ValueSet Problem urn:oid:2.16.840.1.113883.3.88.12.3221.7.4 DYNAMIC (CONF:1098-7335).

18. Observation.entryRelationship
SlicingThis element introduces a set of slices on Observation.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ procedure
  • profile @ procedure,
  • profile @ procedure,
19. Observation.entryRelationship:procedure
SliceNameprocedure
Control0..*
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-7337) such that it

20. Observation.entryRelationship:procedure.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="RSON" Has reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-7338).

Pattern ValueRSON
21. Observation.entryRelationship:procedure.inversionInd
Control1..1
Requirements

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-7343).

Pattern Valuetrue
22. Observation.entryRelationship:procedure.procedure
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure(ProcedureActivityProcedure)
Requirements

SHALL contain exactly one [1..1] Procedure Activity Procedure (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.14:2014-06-09) (CONF:1098-15920).

23. Observation.entryRelationship:medication
SliceNamemedication
Control0..*
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-7340) such that it

24. Observation.entryRelationship:medication.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="RSON" Has reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-7341).

Pattern ValueRSON
25. Observation.entryRelationship:medication.inversionInd
Control1..1
Requirements

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-7344).

Pattern Valuetrue
26. Observation.entryRelationship:medication.substanceAdministration
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration(MedicationActivity)
Requirements

SHALL contain exactly one [1..1] Medication Activity (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.16:2014-06-09) (CONF:1098-15921).

27. Observation.entryRelationship:severity
SliceNameseverity
Control0..1
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1098-7580) such that it

28. Observation.entryRelationship:severity.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="SUBJ" Has subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-7581).

Pattern ValueSUBJ
29. Observation.entryRelationship:severity.inversionInd
Control1..1
Requirements

SHALL contain exactly one [1..1] @inversionInd="true" TRUE (CONF:1098-10375).

Pattern Valuetrue
30. Observation.entryRelationship:severity.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(SeverityObservation)
Requirements

SHALL contain exactly one [1..1] Severity Observation (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.8:2014-06-09) (CONF:1098-15922).

Guidance on how to interpret the contents of this table can be found here.

1. Observation
Definition

Base definition for all types defined in FHIR type system.

Control10..1*
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. Observation.classCode
Control1..1
BindingThe codes SHALL be taken from ActClassObservation
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-7325).

Pattern ValueOBS
3. Observation.moodCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-7326).

Pattern ValueEVN
4. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on Observation.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
5. Observation.templateId:primary
SliceNameprimary
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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-7323) such that it

6. 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.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.9" (CONF:1098-10523).

Pattern Value2.16.840.1.113883.10.20.22.4.9
7. Observation.templateId:primary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32504).

Pattern Value2014-06-09
8. Observation.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control10..*1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IIid
Requirements

SHALL contain at least one [1..*] id (CONF:1098-7329).

Comments

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.

9. Observation.code
Definition

Describes what was observed. Sometimes this is called the observation "name".

Control1..1
BindingThe codes SHALL be taken from ObservationType; other codes may be used where these codes are not suitableFor example codes, see LOINCCodes
Typehttp://hl7.org/fhir/cda/StructureDefinition/CDCodeableConcept
XML RepresentationThe type of this property is determined using the xsi:type attribute.
Requirements

SHALL contain exactly one [1..1] code (CONF:1098-16851).

Knowing what kind of observation is being made is essential to understanding the observation.

Alternate NamesName
Comments

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.

10. Observation.code.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This code SHALL contain exactly one [1..1] @code="ASSERTION" (CONF:1098-31124).

Pattern ValueASSERTION
11. Observation.code.codeSystem
Definition

Specifies the code system that defines the code.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.5.4" (CodeSystem: HL7ActCode urn:oid:2.16.840.1.113883.5.4) (CONF:1098-32169).

Pattern Value2.16.840.1.113883.5.4
12. Observation.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1098-7328).

13. 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.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1098-19114).

Pattern Valuecompleted
14. Observation.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
15. Observation.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
16. Observation.statusCode.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
17. Observation.statusCode.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
18. Observation.statusCode.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
19. Observation.statusCode.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
20. Observation.statusCode.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
21. Observation.effectiveTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7332).

22. Observation.effectiveTime.low
Definition

This is the low limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Requirements

The effectiveTime, if present, SHOULD contain zero or one [0..1] low (CONF:1098-7333).

23. Observation.effectiveTime.high
Definition

This is the high limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Requirements

The effectiveTime, if present, SHOULD contain zero or one [0..1] high (CONF:1098-7334).

24. Observation.value
Control1..1
BindingThe codes SHALL be taken from Problem
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
Requirements

SHALL contain exactly one [1..1] value with @xsi:type="CD", where the code SHALL be selected from ValueSet Problem urn:oid:2.16.840.1.113883.3.88.12.3221.7.4 DYNAMIC (CONF:1098-7335).

25. Observation.entryRelationship
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
obs-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
SlicingThis element introduces a set of slices on Observation.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ procedure
  • profile @ procedure,
  • profile @ procedure,
26. Observation.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
27. Observation.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
28. Observation.entryRelationship:procedure
SliceNameprocedure
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-7337) such that it

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
obs-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
29. Observation.entryRelationship:procedure.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="RSON" Has reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-7338).

Pattern ValueRSON
30. Observation.entryRelationship:procedure.inversionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-7343).

Pattern Valuetrue
31. Observation.entryRelationship:procedure.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
32. Observation.entryRelationship:procedure.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
33. Observation.entryRelationship:procedure.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
34. Observation.entryRelationship:procedure.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
35. Observation.entryRelationship:procedure.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
36. Observation.entryRelationship:procedure.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
37. Observation.entryRelationship:procedure.procedure
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure(ProcedureActivityProcedure)
Requirements

SHALL contain exactly one [1..1] Procedure Activity Procedure (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.14:2014-06-09) (CONF:1098-15920).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. Observation.entryRelationship:procedure.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
39. Observation.entryRelationship:procedure.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
40. Observation.entryRelationship:procedure.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
41. Observation.entryRelationship:medication
SliceNamemedication
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-7340) such that it

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
obs-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
42. Observation.entryRelationship:medication.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="RSON" Has reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-7341).

Pattern ValueRSON
43. Observation.entryRelationship:medication.inversionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-7344).

Pattern Valuetrue
44. Observation.entryRelationship:medication.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
45. Observation.entryRelationship:medication.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
46. Observation.entryRelationship:medication.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
47. Observation.entryRelationship:medication.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
48. Observation.entryRelationship:medication.substanceAdministration
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration(MedicationActivity)
Requirements

SHALL contain exactly one [1..1] Medication Activity (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.16:2014-06-09) (CONF:1098-15921).

InvariantsDefined on this element
1098-30800: Medication Activity **SHOULD** include doseQuantity **OR** rateQuantity (CONF:1098-30800). (: null)
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. Observation.entryRelationship:medication.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
50. Observation.entryRelationship:medication.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
51. Observation.entryRelationship:medication.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
52. Observation.entryRelationship:medication.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
53. Observation.entryRelationship:medication.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
54. Observation.entryRelationship:severity
SliceNameseverity
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1098-7580) such that it

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
obs-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
55. Observation.entryRelationship:severity.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="SUBJ" Has subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-7581).

Pattern ValueSUBJ
56. Observation.entryRelationship:severity.inversionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @inversionInd="true" TRUE (CONF:1098-10375).

Pattern Valuetrue
57. Observation.entryRelationship:severity.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
58. Observation.entryRelationship:severity.observation
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(SeverityObservation)
Requirements

SHALL contain exactly one [1..1] Severity Observation (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.8:2014-06-09) (CONF:1098-15922).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. Observation.entryRelationship:severity.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
60. Observation.entryRelationship:severity.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
61. Observation.entryRelationship:severity.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
62. Observation.entryRelationship:severity.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
63. Observation.entryRelationship:severity.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
64. Observation.entryRelationship:severity.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
65. Observation.entryRelationship:severity.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
66. Observation.entryRelationship:severity.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act

Guidance on how to interpret the contents of this table can be found here.

1. Observation
Definition

Base definition for all types defined in FHIR type system.

Control1..1
2. Observation.classCode
Control1..1
BindingThe codes SHALL be taken from ActClassObservation
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-7325).

Pattern ValueOBS
3. Observation.moodCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-7326).

Pattern ValueEVN
4. Observation.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
5. Observation.realmCode
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
6. Observation.typeId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
7. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on Observation.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
8. Observation.templateId:primary
SliceNameprimary
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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-7323) such that it

9. 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.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
10. 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
11. 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).

Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
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.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.9" (CONF:1098-10523).

Pattern Value2.16.840.1.113883.10.20.22.4.9
13. Observation.templateId:primary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32504).

Pattern Value2014-06-09
14. Observation.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain at least one [1..*] id (CONF:1098-7329).

15. Observation.code
Control1..1
BindingThe codes SHALL be taken from ObservationType; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
Requirements

SHALL contain exactly one [1..1] code (CONF:1098-16851).

16. Observation.code.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
17. Observation.code.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This code SHALL contain exactly one [1..1] @code="ASSERTION" (CONF:1098-31124).

Pattern ValueASSERTION
18. Observation.code.codeSystem
Definition

Specifies the code system that defines the code.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.5.4" (CodeSystem: HL7ActCode urn:oid:2.16.840.1.113883.5.4) (CONF:1098-32169).

Pattern Value2.16.840.1.113883.5.4
19. Observation.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
20. Observation.code.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
21. Observation.code.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
22. Observation.code.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
XML RepresentationIn 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 name valueSet.
23. Observation.code.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
XML RepresentationIn 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 name valueSetVersion.
24. Observation.code.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
25. Observation.code.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
26. Observation.code.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
27. Observation.derivationExpr
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ST
28. Observation.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
XML RepresentationThe type of this property is determined using the xsi:type attribute.
29. Observation.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1098-7328).

30. Observation.statusCode.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
31. 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.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1098-19114).

Pattern Valuecompleted
32. Observation.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
33. Observation.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
34. Observation.statusCode.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
35. Observation.statusCode.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
36. 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.

Control0..1
Typestring
XML RepresentationIn 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 name valueSet.
37. 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.

Control0..1
Typestring
XML RepresentationIn 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 name valueSetVersion.
38. Observation.statusCode.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
39. Observation.statusCode.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
40. Observation.statusCode.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
41. Observation.effectiveTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7332).

42. Observation.effectiveTime.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
43. 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.

Control0..1
TypedateTime
XML RepresentationIn the XML format, this property is represented as an attribute.
44. Observation.effectiveTime.inclusive
Definition

Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).

Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
45. 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.

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
46. Observation.effectiveTime.low
Definition

This is the low limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Requirements

The effectiveTime, if present, SHOULD contain zero or one [0..1] low (CONF:1098-7333).

47. Observation.effectiveTime.high
Definition

This is the high limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Requirements

The effectiveTime, if present, SHOULD contain zero or one [0..1] high (CONF:1098-7334).

48. 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.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
49. 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.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
50. Observation.priorityCode
Control0..1
BindingThe codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
51. Observation.repeatNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-INT
52. Observation.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
53. Observation.value
Control1..1
BindingThe codes SHALL be taken from Problem
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
Requirements

SHALL contain exactly one [1..1] value with @xsi:type="CD", where the code SHALL be selected from ValueSet Problem urn:oid:2.16.840.1.113883.3.88.12.3221.7.4 DYNAMIC (CONF:1098-7335).

54. Observation.interpretationCode
Control0..*
BindingThe codes SHALL be taken from ObservationInterpretation
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
55. Observation.methodCode
Control0..*
BindingThe codes SHALL be taken from ObservationMethod; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
56. Observation.targetSiteCode
Definition

Drawn from concept domain ActSite

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
57. Observation.subject
Control0..1
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
58. Observation.subject.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
59. Observation.subject.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
60. Observation.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueSBJ
Fixed ValueSBJ
61. Observation.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueOP
Fixed ValueOP
62. Observation.subject.awarenessCode
Control0..1
BindingThe codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
63. Observation.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
64. Observation.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
65. Observation.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
66. Observation.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
67. Observation.informant
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
68. Observation.informant.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
69. Observation.informant.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.informant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
70. Observation.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINF
Fixed ValueINF
71. Observation.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueOP
Fixed ValueOP
72. Observation.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
73. Observation.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
74. Observation.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
75. Observation.entryRelationship
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
obs-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
SlicingThis element introduces a set of slices on Observation.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ procedure
  • profile @ procedure,
  • profile @ procedure,
76. Observation.entryRelationship.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
77. Observation.entryRelationship.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
78. Observation.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
79. Observation.entryRelationship.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
80. Observation.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
81. Observation.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
82. Observation.entryRelationship.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
83. Observation.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
84. Observation.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
85. Observation.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
86. Observation.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
87. Observation.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
88. Observation.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
89. Observation.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
90. Observation.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
91. Observation.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
92. Observation.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
93. Observation.entryRelationship:procedure
SliceNameprocedure
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-7337) such that it

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
obs-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
94. Observation.entryRelationship:procedure.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
95. Observation.entryRelationship:procedure.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
96. Observation.entryRelationship:procedure.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="RSON" Has reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-7338).

Pattern ValueRSON
97. Observation.entryRelationship:procedure.inversionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-7343).

Pattern Valuetrue
98. Observation.entryRelationship:procedure.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
99. Observation.entryRelationship:procedure.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
100. Observation.entryRelationship:procedure.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
101. Observation.entryRelationship:procedure.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
102. Observation.entryRelationship:procedure.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
103. Observation.entryRelationship:procedure.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
104. Observation.entryRelationship:procedure.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
105. Observation.entryRelationship:procedure.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
106. Observation.entryRelationship:procedure.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
107. Observation.entryRelationship:procedure.procedure
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure(ProcedureActivityProcedure)
Requirements

SHALL contain exactly one [1..1] Procedure Activity Procedure (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.14:2014-06-09) (CONF:1098-15920).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
108. Observation.entryRelationship:procedure.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
109. Observation.entryRelationship:procedure.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
110. Observation.entryRelationship:procedure.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
111. Observation.entryRelationship:medication
SliceNamemedication
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-7340) such that it

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
obs-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
112. Observation.entryRelationship:medication.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
113. Observation.entryRelationship:medication.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
114. Observation.entryRelationship:medication.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="RSON" Has reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-7341).

Pattern ValueRSON
115. Observation.entryRelationship:medication.inversionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-7344).

Pattern Valuetrue
116. Observation.entryRelationship:medication.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
117. Observation.entryRelationship:medication.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
118. Observation.entryRelationship:medication.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
119. Observation.entryRelationship:medication.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
120. Observation.entryRelationship:medication.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
121. Observation.entryRelationship:medication.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
122. Observation.entryRelationship:medication.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
123. Observation.entryRelationship:medication.substanceAdministration
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration(MedicationActivity)
Requirements

SHALL contain exactly one [1..1] Medication Activity (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.16:2014-06-09) (CONF:1098-15921).

InvariantsDefined on this element
1098-30800: Medication Activity **SHOULD** include doseQuantity **OR** rateQuantity (CONF:1098-30800). (: )
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
124. Observation.entryRelationship:medication.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
125. Observation.entryRelationship:medication.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
126. Observation.entryRelationship:medication.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
127. Observation.entryRelationship:medication.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
128. Observation.entryRelationship:medication.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
129. Observation.entryRelationship:severity
SliceNameseverity
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1098-7580) such that it

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
obs-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
130. Observation.entryRelationship:severity.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
131. Observation.entryRelationship:severity.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
132. Observation.entryRelationship:severity.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="SUBJ" Has subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-7581).

Pattern ValueSUBJ
133. Observation.entryRelationship:severity.inversionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @inversionInd="true" TRUE (CONF:1098-10375).

Pattern Valuetrue
134. Observation.entryRelationship:severity.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
135. Observation.entryRelationship:severity.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
136. Observation.entryRelationship:severity.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
137. Observation.entryRelationship:severity.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
138. Observation.entryRelationship:severity.observation
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(SeverityObservation)
Requirements

SHALL contain exactly one [1..1] Severity Observation (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.8:2014-06-09) (CONF:1098-15922).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
139. Observation.entryRelationship:severity.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
140. Observation.entryRelationship:severity.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
141. Observation.entryRelationship:severity.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
142. Observation.entryRelationship:severity.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
143. Observation.entryRelationship:severity.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
144. Observation.entryRelationship:severity.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
145. Observation.entryRelationship:severity.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
146. Observation.entryRelationship:severity.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
147. Observation.reference
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
148. Observation.reference.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
149. Observation.reference.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.reference.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
150. Observation.reference.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
151. Observation.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
152. Observation.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
153. Observation.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
154. Observation.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
155. Observation.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
156. Observation.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition
157. Observation.referenceRange
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
158. Observation.referenceRange.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
159. Observation.referenceRange.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Observation.referenceRange.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
160. Observation.referenceRange.typeCode
Control1..1
BindingThe codes SHALL be taken from ActRelationshipPertains
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueREFV
Fixed ValueREFV
161. Observation.referenceRange.observationRange
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationRange