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: SubstanceOrDeviceAllergyIntoleranceObservation - Detailed Descriptions

Active as of 2023-01-16

Definitions for the 2.16.840.1.113883.10.20.24.3.90 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-16303).

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-16304).

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-16305) 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.24.3.90" (CONF:1098-16306).

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

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

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

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

9. Observation.code
Requirements

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

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

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

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-32171).

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

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

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) (CONF:1098-26354).

Pattern Valuecompleted
14. Observation.effectiveTime
Control10..1
Requirements

SHALL contain exactly one [1..1] effectiveTime (CONF:1098-16309).

15. Observation.effectiveTime.low
Control1..1
Requirements

This effectiveTime SHALL contain exactly one [1..1] low (CONF:1098-31536).

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

This effectiveTime MAY contain zero or one [0..1] high (CONF:1098-31537).

17. Observation.value
Control10..1*
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" (CONF:1098-16312).

18. Observation.value.code
Control1..1
BindingThe codes SHALL be taken from Allergy and Intolerance Type
Requirements

This value SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet Allergy and Intolerance Type urn:oid:2.16.840.1.113883.3.88.12.3221.6.2 DYNAMIC (CONF:1098-16317).

19. Observation.author
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author(AuthorParticipation)
Requirements

SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-31144).

20. Observation.participant
SlicingThis element introduces a set of slices on Observation.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
21. Observation.participant:participant1
SliceNameparticipant1
Control0..*
Requirements

SHOULD contain zero or more [0..*] participant (CONF:1098-16318) such that it

22. Observation.participant:participant1.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="CSM" Consumable (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1098-16319).

Pattern ValueCSM
23. Observation.participant:participant1.participantRole
Control1..1
Requirements

SHALL contain exactly one [1..1] participantRole (CONF:1098-16320).

24. Observation.participant:participant1.participantRole.classCode
Control1..1
Requirements

This participantRole SHALL contain exactly one [1..1] @classCode="MANU" Manufactured Product (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1098-16321).

Pattern ValueMANU
25. Observation.participant:participant1.participantRole.playingEntity
Control1..1
Requirements

This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1098-16322).

26. Observation.participant:participant1.participantRole.playingEntity.classCode
Control1..1
Requirements

This playingEntity SHALL contain exactly one [1..1] @classCode="MMAT" Manufactured Material (CodeSystem: HL7EntityClass urn:oid:2.16.840.1.113883.5.41 STATIC) (CONF:1098-16323).

Pattern ValueMMAT
27. Observation.participant:participant1.participantRole.playingEntity.code
Control1..1
BindingFor example codes, see Substance Reactant for Intolerance
Requirements

This playingEntity SHALL contain exactly one [1..1] code, which MAY be selected from ValueSet Substance Reactant for Intolerance urn:oid:2.16.840.1.113762.1.4.1010.1 DYNAMIC (CONF:1098-16324).

28. 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 @ observation
29. Observation.entryRelationship:allergyStatus
SliceNameallergyStatus
Control0..1
Requirements

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

30. Observation.entryRelationship:allergyStatus.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-16335).

Pattern ValueSUBJ
31. Observation.entryRelationship:allergyStatus.inversionInd
Control1..1
Requirements

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

Pattern Valuetrue
32. Observation.entryRelationship:allergyStatus.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(AllergyStatusObservation)
Requirements

SHALL contain exactly one [1..1] Allergy Status Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.28:2019-06-20) (CONF:1098-16336).

33. Observation.entryRelationship:reaction
SliceNamereaction
Control0..*
Requirements

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

34. Observation.entryRelationship:reaction.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="MFST" Is Manifestation of (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16339).

Pattern ValueMFST
35. Observation.entryRelationship:reaction.inversionInd
Control1..1
Requirements

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

Pattern Valuetrue
36. Observation.entryRelationship:reaction.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(ReactionObservation)
Requirements

SHALL contain exactly one [1..1] Reaction Observation (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.9:2014-06-09) (CONF:1098-16340).

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

SHOULD NOT contain zero or one [0..1] entryRelationship (CONF:1098-16341) such that it

38. 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-16342).

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

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

Pattern Valuetrue
40. 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-16344).

41. Observation.entryRelationship:criticality
SliceNamecriticality
Control0..1
Requirements

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

42. Observation.entryRelationship:criticality.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) (CONF:1098-32936).

Pattern ValueSUBJ
43. Observation.entryRelationship:criticality.inversionInd
Control1..1
Requirements

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

Pattern Valuetrue
44. Observation.entryRelationship:criticality.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(CriticalityObservation)
Requirements

SHALL contain exactly one [1..1] Criticality Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.145) (CONF:1098-32938).

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-16303).

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-16304).

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-16305) 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.24.3.90" (CONF:1098-16306).

Pattern Value2.16.840.1.113883.10.20.24.3.90
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-32527).

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-16307).

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-16345).

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" Assertion (CONF:1098-16346).

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-32171).

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-16308).

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) (CONF:1098-26354).

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
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

SHALL contain exactly one [1..1] effectiveTime (CONF:1098-16309).

22. Observation.effectiveTime.low
Definition

This is the low limit of the interval.

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

This effectiveTime SHALL contain exactly one [1..1] low (CONF:1098-31536).

23. Observation.effectiveTime.high
Definition

This is the high limit of the interval.

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

This effectiveTime MAY contain zero or one [0..1] high (CONF:1098-31537).

24. Observation.value
Control1..1
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" (CONF:1098-16312).

25. Observation.value.code
Definition

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

Control1..1
BindingThe codes SHALL be taken from Allergy and Intolerance Type
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This value SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet Allergy and Intolerance Type urn:oid:2.16.840.1.113883.3.88.12.3221.6.2 DYNAMIC (CONF:1098-16317).

26. Observation.author
Definition

Base definition for all types defined in FHIR type system.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author(AuthorParticipation)
Requirements

SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-31144).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. Observation.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
SlicingThis element introduces a set of slices on Observation.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
28. Observation.participant:participant1
SliceNameparticipant1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
Requirements

SHOULD contain zero or more [0..*] participant (CONF:1098-16318) such that it

29. Observation.participant:participant1.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="CSM" Consumable (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1098-16319).

Pattern ValueCSM
30. Observation.participant:participant1.participantRole
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParticipantRole
Requirements

SHALL contain exactly one [1..1] participantRole (CONF:1098-16320).

31. Observation.participant:participant1.participantRole.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassRoot
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This participantRole SHALL contain exactly one [1..1] @classCode="MANU" Manufactured Product (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1098-16321).

Default ValueROL
Pattern ValueMANU
32. Observation.participant:participant1.participantRole.playingEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PlayingEntity
Requirements

This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1098-16322).

33. Observation.participant:participant1.participantRole.playingEntity.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassRoot
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This playingEntity SHALL contain exactly one [1..1] @classCode="MMAT" Manufactured Material (CodeSystem: HL7EntityClass urn:oid:2.16.840.1.113883.5.41 STATIC) (CONF:1098-16323).

Default ValueENT
Pattern ValueMMAT
34. Observation.participant:participant1.participantRole.playingEntity.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
35. Observation.participant:participant1.participantRole.playingEntity.code
Control1..1
BindingFor example codes, see Substance Reactant for Intolerance
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

This playingEntity SHALL contain exactly one [1..1] code, which MAY be selected from ValueSet Substance Reactant for Intolerance urn:oid:2.16.840.1.113762.1.4.1010.1 DYNAMIC (CONF:1098-16324).

36. 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 @ observation
37. Observation.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
38. Observation.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
39. Observation.entryRelationship:allergyStatus
SliceNameallergyStatus
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1098-16333) 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)
40. Observation.entryRelationship:allergyStatus.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-16335).

Pattern ValueSUBJ
41. Observation.entryRelationship:allergyStatus.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-16334).

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Allergy Status Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.28:2019-06-20) (CONF:1098-16336).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. Observation.entryRelationship:allergyStatus.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
45. Observation.entryRelationship:allergyStatus.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
46. Observation.entryRelationship:allergyStatus.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
47. Observation.entryRelationship:allergyStatus.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
48. Observation.entryRelationship:allergyStatus.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
49. Observation.entryRelationship:allergyStatus.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
50. Observation.entryRelationship:allergyStatus.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
51. Observation.entryRelationship:allergyStatus.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
52. Observation.entryRelationship:reaction
SliceNamereaction
Control0..*
TypeElement
Requirements

SHOULD contain zero or more [0..*] entryRelationship (CONF:1098-16337) 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)
53. Observation.entryRelationship:reaction.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="MFST" Is Manifestation of (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16339).

Pattern ValueMFST
54. Observation.entryRelationship:reaction.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-16338).

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Reaction Observation (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.9:2014-06-09) (CONF:1098-16340).

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

SHOULD NOT contain zero or one [0..1] entryRelationship (CONF:1098-16341) 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)
66. 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-16342).

Pattern ValueSUBJ
67. 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-16343).

Pattern Valuetrue
68. Observation.entryRelationship:severity.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
69. 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-16344).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
70. Observation.entryRelationship:severity.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
71. Observation.entryRelationship:severity.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
72. Observation.entryRelationship:severity.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
73. Observation.entryRelationship:severity.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
74. Observation.entryRelationship:severity.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
75. Observation.entryRelationship:severity.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
76. Observation.entryRelationship:severity.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
77. Observation.entryRelationship:severity.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
78. Observation.entryRelationship:criticality
SliceNamecriticality
Control0..1
TypeElement
Requirements

SHOULD contain zero or one [0..1] entryRelationship (CONF:1098-32935) 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)
79. Observation.entryRelationship:criticality.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) (CONF:1098-32936).

Pattern ValueSUBJ
80. Observation.entryRelationship:criticality.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-32937).

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Criticality Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.145) (CONF:1098-32938).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
83. Observation.entryRelationship:criticality.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
84. Observation.entryRelationship:criticality.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
85. Observation.entryRelationship:criticality.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
86. Observation.entryRelationship:criticality.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
87. Observation.entryRelationship:criticality.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
88. Observation.entryRelationship:criticality.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
89. Observation.entryRelationship:criticality.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
90. Observation.entryRelationship:criticality.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-16303).

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-16304).

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-16305) 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.24.3.90" (CONF:1098-16306).

Pattern Value2.16.840.1.113883.10.20.24.3.90
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-32527).

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-16307).

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-16345).

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" Assertion (CONF:1098-16346).

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-32171).

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-16308).

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) (CONF:1098-26354).

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
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

SHALL contain exactly one [1..1] effectiveTime (CONF:1098-16309).

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.

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

This effectiveTime SHALL contain exactly one [1..1] low (CONF:1098-31536).

47. Observation.effectiveTime.high
Definition

This is the high limit of the interval.

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

This effectiveTime MAY contain zero or one [0..1] high (CONF:1098-31537).

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
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" (CONF:1098-16312).

54. Observation.value.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.
55. Observation.value.code
Definition

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

Control1..1
BindingThe codes SHALL be taken from Allergy and Intolerance Type
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This value SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet Allergy and Intolerance Type urn:oid:2.16.840.1.113883.3.88.12.3221.6.2 DYNAMIC (CONF:1098-16317).

56. Observation.value.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
57. Observation.value.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
58. Observation.value.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.
59. Observation.value.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.
60. Observation.value.sdtcValueSet
Definition

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

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.
61. Observation.value.sdtcValueSetVersion
Definition

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

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.
62. Observation.value.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
63. Observation.value.qualifier
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
64. Observation.value.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.
65. Observation.interpretationCode
Control0..*
BindingThe codes SHALL be taken from ObservationInterpretation
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
66. 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
67. Observation.targetSiteCode
Definition

Drawn from concept domain ActSite

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
68. 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()))
69. 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
70. 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
71. 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
72. 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
73. 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
74. Observation.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
75. Observation.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
76. Observation.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
77. Observation.author
Definition

Base definition for all types defined in FHIR type system.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author(AuthorParticipation)
Requirements

SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-31144).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
78. 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()))
79. 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
80. 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
81. 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
82. 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
83. Observation.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
84. Observation.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
85. Observation.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
SlicingThis element introduces a set of slices on Observation.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
86. Observation.participant:participant1
SliceNameparticipant1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
Requirements

SHOULD contain zero or more [0..*] participant (CONF:1098-16318) such that it

87. Observation.participant:participant1.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.
88. Observation.participant:participant1.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="CSM" Consumable (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1098-16319).

Pattern ValueCSM
89. Observation.participant:participant1.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueOP
90. Observation.participant:participant1.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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
91. Observation.participant:participant1.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.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
92. Observation.participant:participant1.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
93. Observation.participant:participant1.sdtcFunctionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name functionCode.
94. Observation.participant:participant1.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
95. Observation.participant:participant1.awarenessCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
96. Observation.participant:participant1.participantRole
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParticipantRole
Requirements

SHALL contain exactly one [1..1] participantRole (CONF:1098-16320).

97. Observation.participant:participant1.participantRole.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassRoot
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This participantRole SHALL contain exactly one [1..1] @classCode="MANU" Manufactured Product (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1098-16321).

Default ValueROL
Pattern ValueMANU
98. Observation.participant:participant1.participantRole.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
99. Observation.participant:participant1.participantRole.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
100. Observation.participant:participant1.participantRole.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
101. Observation.participant:participant1.participantRole.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
102. Observation.participant:participant1.participantRole.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
103. Observation.participant:participant1.participantRole.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
104. Observation.participant:participant1.participantRole.playingDevice
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Device
105. Observation.participant:participant1.participantRole.playingEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PlayingEntity
Requirements

This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1098-16322).

106. Observation.participant:participant1.participantRole.playingEntity.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassRoot
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This playingEntity SHALL contain exactly one [1..1] @classCode="MMAT" Manufactured Material (CodeSystem: HL7EntityClass urn:oid:2.16.840.1.113883.5.41 STATIC) (CONF:1098-16323).

Default ValueENT
Pattern ValueMMAT
107. Observation.participant:participant1.participantRole.playingEntity.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
108. Observation.participant:participant1.participantRole.playingEntity.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
109. Observation.participant:participant1.participantRole.playingEntity.code
Control1..1
BindingFor example codes, see Substance Reactant for Intolerance
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

This playingEntity SHALL contain exactly one [1..1] code, which MAY be selected from ValueSet Substance Reactant for Intolerance urn:oid:2.16.840.1.113762.1.4.1010.1 DYNAMIC (CONF:1098-16324).

110. Observation.participant:participant1.participantRole.playingEntity.quantity
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
111. Observation.participant:participant1.participantRole.playingEntity.name
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/EN
112. Observation.participant:participant1.participantRole.playingEntity.desc
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
113. Observation.participant:participant1.participantRole.scopingEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Entity
114. 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 @ observation
115. 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
116. 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
117. Observation.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
118. Observation.entryRelationship.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
119. Observation.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
120. Observation.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
121. Observation.entryRelationship.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
122. Observation.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
123. Observation.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
124. Observation.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
125. Observation.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
126. Observation.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
127. Observation.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
128. Observation.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
129. Observation.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
130. Observation.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
131. Observation.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
132. Observation.entryRelationship:allergyStatus
SliceNameallergyStatus
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1098-16333) 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)
133. Observation.entryRelationship:allergyStatus.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
134. Observation.entryRelationship:allergyStatus.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
135. Observation.entryRelationship:allergyStatus.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-16335).

Pattern ValueSUBJ
136. Observation.entryRelationship:allergyStatus.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-16334).

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

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Allergy Status Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.28:2019-06-20) (CONF:1098-16336).

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

SHOULD contain zero or more [0..*] entryRelationship (CONF:1098-16337) 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)
151. Observation.entryRelationship:reaction.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
152. Observation.entryRelationship:reaction.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
153. Observation.entryRelationship:reaction.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="MFST" Is Manifestation of (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16339).

Pattern ValueMFST
154. Observation.entryRelationship:reaction.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-16338).

Pattern Valuetrue
155. Observation.entryRelationship:reaction.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
156. Observation.entryRelationship:reaction.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
157. Observation.entryRelationship:reaction.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
158. Observation.entryRelationship:reaction.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
159. Observation.entryRelationship:reaction.observation
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Reaction Observation (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.9:2014-06-09) (CONF:1098-16340).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
160. Observation.entryRelationship:reaction.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
161. Observation.entryRelationship:reaction.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
162. Observation.entryRelationship:reaction.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
163. Observation.entryRelationship:reaction.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
164. Observation.entryRelationship:reaction.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
165. Observation.entryRelationship:reaction.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
166. Observation.entryRelationship:reaction.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
167. Observation.entryRelationship:reaction.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
168. Observation.entryRelationship:severity
SliceNameseverity
Control0..1
TypeElement
Requirements

SHOULD NOT contain zero or one [0..1] entryRelationship (CONF:1098-16341) 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)
169. 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
170. 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
171. 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-16342).

Pattern ValueSUBJ
172. 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-16343).

Pattern Valuetrue
173. Observation.entryRelationship:severity.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
174. Observation.entryRelationship:severity.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
175. Observation.entryRelationship:severity.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
176. Observation.entryRelationship:severity.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
177. 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-16344).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
178. Observation.entryRelationship:severity.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
179. Observation.entryRelationship:severity.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
180. Observation.entryRelationship:severity.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
181. Observation.entryRelationship:severity.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
182. Observation.entryRelationship:severity.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
183. Observation.entryRelationship:severity.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
184. Observation.entryRelationship:severity.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
185. Observation.entryRelationship:severity.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
186. Observation.entryRelationship:criticality
SliceNamecriticality
Control0..1
TypeElement
Requirements

SHOULD contain zero or one [0..1] entryRelationship (CONF:1098-32935) 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)
187. Observation.entryRelationship:criticality.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
188. Observation.entryRelationship:criticality.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
189. Observation.entryRelationship:criticality.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) (CONF:1098-32936).

Pattern ValueSUBJ
190. Observation.entryRelationship:criticality.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-32937).

Pattern Valuetrue
191. Observation.entryRelationship:criticality.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
192. Observation.entryRelationship:criticality.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
193. Observation.entryRelationship:criticality.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
194. Observation.entryRelationship:criticality.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
195. Observation.entryRelationship:criticality.observation
Definition

Base definition for all types defined in FHIR type system.

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

SHALL contain exactly one [1..1] Criticality Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.145) (CONF:1098-32938).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
196. Observation.entryRelationship:criticality.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
197. Observation.entryRelationship:criticality.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
198. Observation.entryRelationship:criticality.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
199. Observation.entryRelationship:criticality.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
200. Observation.entryRelationship:criticality.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
201. Observation.entryRelationship:criticality.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
202. Observation.entryRelationship:criticality.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
203. Observation.entryRelationship:criticality.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
204. 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()))
205. 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
206. 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
207. Observation.reference.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
208. Observation.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
209. Observation.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
210. Observation.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
211. Observation.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
212. Observation.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
213. Observation.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition
214. 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()))
215. 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
216. 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
217. 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
218. Observation.referenceRange.observationRange
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationRange