Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build
United States of America
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) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions 
| Active as of 2023-01-16 |
Definitions for the 2.16.840.1.113883.10.20.22.4.7 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-7379). SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-16303). |
| 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-7380). SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-16304). |
| 4. Observation.negationInd | |
| Requirements | MAY contain zero or one [0..1] @negationInd (CONF:1098-31526). |
| 5. Observation.templateId | |
| Slicing | This element introduces a set of slices on Observation.templateId. The slices are and , and can be differentiated using the following discriminators:
|
| 6. Observation.templateId:secondary | |
| SliceName | secondary |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] templateId (CONF:1098-7381) such that it |
| 7. Observation.templateId:secondary.root | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.7" (CONF:1098-10488). |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.7 |
| 8. Observation.templateId:secondary.extension | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32526). |
| Pattern Value | 2014-06-09 |
| 9. Observation.id | |
| Requirements | SHALL contain at least one [1..*] id (CONF:1098-7382). SHALL contain at least one [1..*] id (CONF:1098-16307). |
| 10. Observation.code | |
| Requirements | SHALL contain exactly one [1..1] code (CONF:1098-15947). SHALL contain exactly one [1..1] code (CONF:1098-16345). |
| 11. Observation.code.code | |
| Requirements | This code SHALL contain exactly one [1..1] @code="ASSERTION" Assertion (CONF:1098-15948). This code SHALL contain exactly one [1..1] @code="ASSERTION" Assertion (CONF:1098-16346). |
| 12. Observation.code.codeSystem | |
| 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-32153). 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). |
| 13. Observation.statusCode | |
| Requirements | SHALL contain exactly one [1..1] statusCode (CONF:1098-19084). SHALL contain exactly one [1..1] statusCode (CONF:1098-16308). |
| 14. Observation.statusCode.code | |
| Requirements | This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1098-19085). 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). |
| 15. Observation.effectiveTime | |
| Requirements | SHALL contain exactly one [1..1] effectiveTime (CONF:1098-7387). SHALL contain exactly one [1..1] effectiveTime (CONF:1098-16309). |
| 16. Observation.effectiveTime.low | |
| Requirements | This effectiveTime SHALL contain exactly one [1..1] low (CONF:1098-31538). This effectiveTime SHALL contain exactly one [1..1] low (CONF:1098-31536). |
| 17. Observation.effectiveTime.high | |
| Requirements | This effectiveTime MAY contain zero or one [0..1] high (CONF:1098-31539). This effectiveTime MAY contain zero or one [0..1] high (CONF:1098-31537). |
| 18. Observation.value | |
| Binding | The codes SHALL be taken from Allergy and Intolerance TypeFor codes, see (unbound) |
| Requirements | SHALL contain exactly one [1..1] value with @xsi:type="CD", where the code 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-7390). SHALL contain exactly one [1..1] value with @xsi:type="CD" (CONF:1098-16312). |
| 19. Observation.author | |
| Type | http://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-31143). 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.entryRelationship | |
| Slicing | This element introduces a set of slices on Observation.entryRelationship. The slices are and , and can be differentiated using the following discriminators:
|
| 21. Observation.entryRelationship:criticality | |
| SliceName | criticality |
| Requirements | SHOULD contain zero or one [0..1] entryRelationship (CONF:1098-32910) such that it SHOULD contain zero or one [0..1] entryRelationship (CONF:1098-32935) such that it |
| 22. Observation.entryRelationship:criticality.typeCode | |
| Requirements | SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32911). SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32936). |
| 23. Observation.entryRelationship:criticality.inversionInd | |
| Requirements | SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-32912). SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-32937). |
| 24. Observation.entryRelationship:criticality.observation | |
| Type | http://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-32913). 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. |
| Control | 10..1* |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 2. Observation.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClassObservation |
| Type | code |
| XML Representation | In 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-7379). |
| Pattern Value | OBS |
| 3. Observation.moodCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In 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-7380). |
| Pattern Value | EVN |
| 4. Observation.negationInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | MAY contain zero or one [0..1] @negationInd (CONF:1098-31526). |
| 5. Observation.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Slicing | This element introduces a set of slices on Observation.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 6. Observation.templateId:primary | |
| SliceName | primary |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain exactly one [1..1] templateId (CONF:1098-16305) such that it |
| 7. 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. |
| Control | 1..1 |
| Type | string |
| XML Representation | In 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 Value | 2.16.840.1.113883.10.20.24.3.90 |
| 8. Observation.templateId:primary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string |
| XML Representation | In 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 Value | 2014-06-09 |
| 9. Observation.templateId:secondary | |
| SliceName | secondary |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain exactly one [1..1] templateId (CONF:1098-7381) such that it |
| 10. Observation.templateId:secondary.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.7" (CONF:1098-10488). |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.7 |
| 11. Observation.templateId:secondary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32526). |
| Pattern Value | 2014-06-09 |
| 12. Observation.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Control | 10..*1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IIid |
| Requirements | SHALL contain at least one [1..*] id (CONF:1098-7382). |
| 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. |
| 13. Observation.code | |
| Definition | Describes what was observed. Sometimes this is called the observation "name". |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ObservationType; other codes may be used where these codes are not suitableFor example codes, see LOINCCodes |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CDCodeableConcept |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| Requirements | SHALL contain exactly one [1..1] code (CONF:1098-15947). Knowing what kind of observation is being made is essential to understanding the observation. |
| Alternate Names | Name |
| 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. |
| 14. 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. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | This code SHALL contain exactly one [1..1] @code="ASSERTION" Assertion (CONF:1098-15948). |
| Pattern Value | ASSERTION |
| 15. Observation.code.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 1..1 |
| Type | string |
| XML Representation | In 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-32153). |
| Pattern Value | 2.16.840.1.113883.5.4 |
| 16. Observation.statusCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| Requirements | SHALL contain exactly one [1..1] statusCode (CONF:1098-19084). |
| 17. 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. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1098-19085). |
| Pattern Value | completed |
| 18. Observation.statusCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 19. Observation.statusCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 20. Observation.statusCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 21. Observation.statusCode.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 22. Observation.statusCode.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 23. Observation.statusCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 24. Observation.statusCode.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 25. Observation.effectiveTime | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| Requirements | SHALL contain exactly one [1..1] effectiveTime (CONF:1098-7387). |
| 26. Observation.effectiveTime.low | |
| Definition | This is the low limit of the interval. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| Requirements | This effectiveTime SHALL contain exactly one [1..1] low (CONF:1098-31538). |
| 27. Observation.effectiveTime.high | |
| Definition | This is the high limit of the interval. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| Requirements | This effectiveTime MAY contain zero or one [0..1] high (CONF:1098-31539). |
| 28. Observation.value | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Allergy and Intolerance Type |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| Requirements | SHALL contain exactly one [1..1] value with @xsi:type="CD", where the code SHALL be selected from ValueSet Allergy and Intolerance Type urn:oid:2.16.840.1.113883.3.88.12.3221.6.2 DYNAMIC (CONF:1098-7390). |
| 29. 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. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Allergy and Intolerance Type |
| Type | string |
| XML Representation | In 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). |
| 30. Observation.author | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 0..* |
| Type | http://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-31143). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 31. Observation.participant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant2 |
| Slicing | This element introduces a set of slices on Observation.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 32. Observation.participant:participant1 | |
| SliceName | participant1 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant2 |
| Requirements | SHOULD contain zero or more [0..*] participant (CONF:1098-16318) such that it |
| 33. Observation.participant:participant1.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In 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 Value | CSM |
| 34. Observation.participant:participant1.participantRole | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ParticipantRole |
| Requirements | SHALL contain exactly one [1..1] participantRole (CONF:1098-16320). |
| 35. Observation.participant:participant1.participantRole.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassRoot |
| Type | code |
| XML Representation | In 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 Value | ROL |
| Pattern Value | MANU |
| 36. Observation.participant:participant1.participantRole.playingEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PlayingEntity |
| Requirements | This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1098-16322). |
| 37. Observation.participant:participant1.participantRole.playingEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassRoot |
| Type | code |
| XML Representation | In 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 Value | ENT |
| Pattern Value | MMAT |
| 38. Observation.participant:participant1.participantRole.playingEntity.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 39. Observation.participant:participant1.participantRole.playingEntity.code | |
| Control | 1..1 |
| Binding | For example codes, see Substance Reactant for Intolerance |
| Type | http://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). |
| 40. Observation.entryRelationship | |
| Control | 0..* |
| Type | Element |
| Invariants | Defined 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) |
| Slicing | This element introduces a set of slices on Observation.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 41. Observation.entryRelationship:allergyStatus | |
| SliceName | allergyStatus |
| Control | 0..1 |
| Type | Element |
| Requirements | MAY contain zero or one [0..1] entryRelationship (CONF:1098-16333) such that it |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) obs-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1) |
| 42. Observation.entryRelationship:allergyStatus.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In 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 Value | SUBJ |
| 43. Observation.entryRelationship:allergyStatus.inversionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16334). |
| Pattern Value | true |
| 44. Observation.entryRelationship:allergyStatus.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 45. Observation.entryRelationship:allergyStatus.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://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). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 46. Observation.entryRelationship:allergyStatus.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 47. Observation.entryRelationship:allergyStatus.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 48. Observation.entryRelationship:allergyStatus.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 49. Observation.entryRelationship:allergyStatus.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 50. Observation.entryRelationship:allergyStatus.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 51. Observation.entryRelationship:allergyStatus.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 52. Observation.entryRelationship:allergyStatus.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 53. Observation.entryRelationship:allergyStatus.act | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 54. Observation.entryRelationship:reaction | |
| SliceName | reaction |
| Control | 0..* |
| Type | Element |
| Requirements | SHOULD contain zero or more [0..*] entryRelationship (CONF:1098-16337) such that it |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) obs-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1) |
| 55. Observation.entryRelationship:reaction.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In 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 Value | MFST |
| 56. Observation.entryRelationship:reaction.inversionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16338). |
| Pattern Value | true |
| 57. Observation.entryRelationship:reaction.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 58. Observation.entryRelationship:reaction.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://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). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 59. Observation.entryRelationship:reaction.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 60. Observation.entryRelationship:reaction.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 61. Observation.entryRelationship:reaction.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 62. Observation.entryRelationship:reaction.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 63. Observation.entryRelationship:reaction.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 64. Observation.entryRelationship:reaction.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 65. Observation.entryRelationship:reaction.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 66. Observation.entryRelationship:reaction.act | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 67. Observation.entryRelationship:severity | |
| SliceName | severity |
| Control | 0..1 |
| Type | Element |
| Requirements | SHOULD NOT contain zero or one [0..1] entryRelationship (CONF:1098-16341) such that it |
| Invariants | Defined 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) |
| 68. Observation.entryRelationship:severity.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In 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 Value | SUBJ |
| 69. Observation.entryRelationship:severity.inversionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16343). |
| Pattern Value | true |
| 70. Observation.entryRelationship:severity.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 71. Observation.entryRelationship:severity.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://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). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 72. Observation.entryRelationship:severity.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 73. Observation.entryRelationship:severity.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 74. Observation.entryRelationship:severity.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 75. Observation.entryRelationship:severity.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 76. Observation.entryRelationship:severity.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 77. Observation.entryRelationship:severity.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 78. Observation.entryRelationship:severity.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 79. Observation.entryRelationship:severity.act | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 80. Observation.entryRelationship:criticality | |
| SliceName | criticality |
| Control | 0..1 |
| Type | Element |
| Requirements | SHOULD contain zero or one [0..1] entryRelationship (CONF:1098-32910) such that it |
| Invariants | Defined 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) |
| 81. Observation.entryRelationship:criticality.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In 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-32911). |
| Pattern Value | SUBJ |
| 82. Observation.entryRelationship:criticality.inversionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-32912). |
| Pattern Value | true |
| 83. Observation.entryRelationship:criticality.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 84. Observation.entryRelationship:criticality.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://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-32913). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 85. Observation.entryRelationship:criticality.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 86. Observation.entryRelationship:criticality.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 87. Observation.entryRelationship:criticality.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 88. Observation.entryRelationship:criticality.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 89. Observation.entryRelationship:criticality.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 90. Observation.entryRelationship:criticality.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 91. Observation.entryRelationship:criticality.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 92. Observation.entryRelationship:criticality.act | |
| Control | 0..0 |
| Type | http://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. |
| Control | 1..1 |
| 2. Observation.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClassObservation |
| Type | code |
| XML Representation | In 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-7379). |
| Pattern Value | OBS |
| 3. Observation.moodCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In 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-7380). |
| Pattern Value | EVN |
| 4. Observation.negationInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | MAY contain zero or one [0..1] @negationInd (CONF:1098-31526). |
| 5. Observation.realmCode | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 6. Observation.typeId | |
| Control | 0..1 |
| Type | http://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 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Slicing | This element introduces a set of slices on Observation.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 8. Observation.templateId:primary | |
| SliceName | primary |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 1..1 |
| Type | http://hl7.org/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. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In 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. |
| Control | 0..1 |
| Type | string |
| XML Representation | In 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). |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In 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. |
| Control | 1..1 |
| Type | string |
| XML Representation | In 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 Value | 2.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. |
| Control | 1..1 |
| Type | string |
| XML Representation | In 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 Value | 2014-06-09 |
| 14. Observation.templateId:secondary | |
| SliceName | secondary |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain exactly one [1..1] templateId (CONF:1098-7381) such that it |
| 15. Observation.templateId:secondary.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 16. Observation.templateId:secondary.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 17. Observation.templateId:secondary.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 18. Observation.templateId:secondary.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.7" (CONF:1098-10488). |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.7 |
| 19. Observation.templateId:secondary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32526). |
| Pattern Value | 2014-06-09 |
| 20. Observation.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain at least one [1..*] id (CONF:1098-7382). |
| 21. Observation.code | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ObservationType; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| Requirements | SHALL contain exactly one [1..1] code (CONF:1098-15947). |
| 22. Observation.code.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 23. 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. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | This code SHALL contain exactly one [1..1] @code="ASSERTION" Assertion (CONF:1098-15948). |
| Pattern Value | ASSERTION |
| 24. Observation.code.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 1..1 |
| Type | string |
| XML Representation | In 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-32153). |
| Pattern Value | 2.16.840.1.113883.5.4 |
| 25. Observation.code.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 26. Observation.code.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 27. Observation.code.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 28. 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. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet. |
| 29. 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. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion. |
| 30. Observation.code.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 31. Observation.code.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 32. Observation.code.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 33. Observation.derivationExpr | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ST |
| 34. Observation.text | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 35. Observation.statusCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| Requirements | SHALL contain exactly one [1..1] statusCode (CONF:1098-19084). |
| 36. Observation.statusCode.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 37. 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. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1098-19085). |
| Pattern Value | completed |
| 38. Observation.statusCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 39. Observation.statusCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 40. Observation.statusCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 41. Observation.statusCode.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 42. Observation.statusCode.sdtcValueSet | |
| Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet. |
| 43. Observation.statusCode.sdtcValueSetVersion | |
| Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion. |
| 44. Observation.statusCode.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 45. Observation.statusCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 46. Observation.statusCode.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 47. Observation.effectiveTime | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| Requirements | SHALL contain exactly one [1..1] effectiveTime (CONF:1098-7387). |
| 48. Observation.effectiveTime.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 49. Observation.effectiveTime.value | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 0..1 |
| Type | dateTime |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 50. Observation.effectiveTime.inclusive | |
| Definition | Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open). |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 51. Observation.effectiveTime.operator | |
| Definition | A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 52. Observation.effectiveTime.low | |
| Definition | This is the low limit of the interval. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| Requirements | This effectiveTime SHALL contain exactly one [1..1] low (CONF:1098-31538). |
| 53. Observation.effectiveTime.high | |
| Definition | This is the high limit of the interval. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| Requirements | This effectiveTime MAY contain zero or one [0..1] high (CONF:1098-31539). |
| 54. Observation.effectiveTime.width | |
| Definition | The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PQ |
| 55. Observation.effectiveTime.center | |
| Definition | The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| 56. Observation.priorityCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 57. Observation.repeatNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-INT |
| 58. Observation.languageCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from HumanLanguage |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 59. Observation.value | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Allergy and Intolerance Type |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| Requirements | SHALL contain exactly one [1..1] value with @xsi:type="CD", where the code SHALL be selected from ValueSet Allergy and Intolerance Type urn:oid:2.16.840.1.113883.3.88.12.3221.6.2 DYNAMIC (CONF:1098-7390). |
| 60. Observation.value.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 61. 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. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Allergy and Intolerance Type |
| Type | string |
| XML Representation | In 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). |
| 62. Observation.value.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 63. Observation.value.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 64. Observation.value.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 65. Observation.value.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 66. Observation.value.sdtcValueSet | |
| Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet. |
| 67. Observation.value.sdtcValueSetVersion | |
| Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion. |
| 68. Observation.value.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 69. Observation.value.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 70. Observation.value.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 71. Observation.interpretationCode | |
| Control | 0..* |
| Binding | The codes SHALL be taken from ObservationInterpretation |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 72. Observation.methodCode | |
| Control | 0..* |
| Binding | The codes SHALL be taken from ObservationMethod; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 73. Observation.targetSiteCode | |
| Definition | Drawn from concept domain ActSite |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| 74. Observation.subject | |
| Control | 0..1 |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 75. 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. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 76. 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, 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. |
| Invariants | Defined 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()) |
| Slicing | This element introduces a set of slices on Observation.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 77. Observation.subject.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationTargetSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | SBJ |
| Fixed Value | SBJ |
| 78. Observation.subject.contextControlCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | OP |
| Fixed Value | OP |
| 79. Observation.subject.awarenessCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 80. Observation.subject.relatedSubject | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedSubject |
| 81. Observation.specimen | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Specimen |
| 82. Observation.performer | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Performer2 |
| 83. Observation.author | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 0..* |
| Type | http://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-31143). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 84. Observation.informant | |
| Control | 0..* |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 85. 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. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 86. 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, 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. |
| Invariants | Defined 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()) |
| Slicing | This element introduces a set of slices on Observation.informant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 87. Observation.informant.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationInformationGenerator |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INF |
| Fixed Value | INF |
| 88. Observation.informant.contextControlCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | OP |
| Fixed Value | OP |
| 89. Observation.informant.assignedEntity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| 90. Observation.informant.relatedEntity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity |
| 91. Observation.participant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant2 |
| Slicing | This element introduces a set of slices on Observation.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 92. Observation.participant:participant1 | |
| SliceName | participant1 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant2 |
| Requirements | SHOULD contain zero or more [0..*] participant (CONF:1098-16318) such that it |
| 93. 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. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 94. Observation.participant:participant1.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In 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 Value | CSM |
| 95. Observation.participant:participant1.contextControlCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | OP |
| 96. 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 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 97. 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. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 98. 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 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 99. Observation.participant:participant1.sdtcFunctionCode | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name functionCode. |
| 100. Observation.participant:participant1.time | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| 101. Observation.participant:participant1.awarenessCode | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 102. Observation.participant:participant1.participantRole | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ParticipantRole |
| Requirements | SHALL contain exactly one [1..1] participantRole (CONF:1098-16320). |
| 103. Observation.participant:participant1.participantRole.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassRoot |
| Type | code |
| XML Representation | In 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 Value | ROL |
| Pattern Value | MANU |
| 104. 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 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 105. Observation.participant:participant1.participantRole.id | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 106. Observation.participant:participant1.participantRole.sdtcIdentifiedBy | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy. |
| 107. Observation.participant:participant1.participantRole.code | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 108. Observation.participant:participant1.participantRole.addr | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AD |
| 109. Observation.participant:participant1.participantRole.telecom | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
| 110. Observation.participant:participant1.participantRole.playingDevice | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Device |
| 111. Observation.participant:participant1.participantRole.playingEntity | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PlayingEntity |
| Requirements | This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1098-16322). |
| 112. Observation.participant:participant1.participantRole.playingEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassRoot |
| Type | code |
| XML Representation | In 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 Value | ENT |
| Pattern Value | MMAT |
| 113. Observation.participant:participant1.participantRole.playingEntity.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 114. 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 |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 115. Observation.participant:participant1.participantRole.playingEntity.code | |
| Control | 1..1 |
| Binding | For example codes, see Substance Reactant for Intolerance |
| Type | http://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). |
| 116. Observation.participant:participant1.participantRole.playingEntity.quantity | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PQ |
| 117. Observation.participant:participant1.participantRole.playingEntity.name | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/EN |
| 118. Observation.participant:participant1.participantRole.playingEntity.desc | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 119. Observation.participant:participant1.participantRole.scopingEntity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Entity |
| 120. Observation.entryRelationship | |
| Control | 0..* |
| Type | Element |
| Invariants | Defined 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) |
| Slicing | This element introduces a set of slices on Observation.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 121. Observation.entryRelationship:allergyStatus | |
| SliceName | allergyStatus |
| Control | 0..1 |
| Type | Element |
| Requirements | MAY contain zero or one [0..1] entryRelationship (CONF:1098-16333) such that it |
| Invariants | Defined 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) |
| 122. 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. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 123. 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, 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. |
| Invariants | Defined 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()) |
| Slicing | This element introduces a set of slices on Observation.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 124. Observation.entryRelationship:allergyStatus.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In 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 Value | SUBJ |
| 125. Observation.entryRelationship:allergyStatus.inversionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16334). |
| Pattern Value | true |
| 126. Observation.entryRelationship:allergyStatus.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 127. Observation.entryRelationship:allergyStatus.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 128. Observation.entryRelationship:allergyStatus.negationInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 129. Observation.entryRelationship:allergyStatus.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 130. Observation.entryRelationship:allergyStatus.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://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). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 131. Observation.entryRelationship:allergyStatus.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 132. Observation.entryRelationship:allergyStatus.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 133. Observation.entryRelationship:allergyStatus.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 134. Observation.entryRelationship:allergyStatus.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 135. Observation.entryRelationship:allergyStatus.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 136. Observation.entryRelationship:allergyStatus.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 137. Observation.entryRelationship:allergyStatus.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 138. Observation.entryRelationship:allergyStatus.act | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 139. Observation.entryRelationship:reaction | |
| SliceName | reaction |
| Control | 0..* |
| Type | Element |
| Requirements | SHOULD contain zero or more [0..*] entryRelationship (CONF:1098-16337) such that it |
| Invariants | Defined 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) |
| 140. 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. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 141. 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, 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. |
| Invariants | Defined 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()) |
| Slicing | This element introduces a set of slices on Observation.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 142. Observation.entryRelationship:reaction.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In 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 Value | MFST |
| 143. Observation.entryRelationship:reaction.inversionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16338). |
| Pattern Value | true |
| 144. Observation.entryRelationship:reaction.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 145. Observation.entryRelationship:reaction.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 146. Observation.entryRelationship:reaction.negationInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 147. Observation.entryRelationship:reaction.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 148. Observation.entryRelationship:reaction.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://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). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 149. Observation.entryRelationship:reaction.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 150. Observation.entryRelationship:reaction.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 151. Observation.entryRelationship:reaction.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 152. Observation.entryRelationship:reaction.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 153. Observation.entryRelationship:reaction.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 154. Observation.entryRelationship:reaction.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 155. Observation.entryRelationship:reaction.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 156. Observation.entryRelationship:reaction.act | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 157. Observation.entryRelationship:severity | |
| SliceName | severity |
| Control | 0..1 |
| Type | Element |
| Requirements | SHOULD NOT contain zero or one [0..1] entryRelationship (CONF:1098-16341) such that it |
| Invariants | Defined 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) |
| 158. 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. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 159. 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, 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. |
| Invariants | Defined 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()) |
| Slicing | This element introduces a set of slices on Observation.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 160. Observation.entryRelationship:severity.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In 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 Value | SUBJ |
| 161. Observation.entryRelationship:severity.inversionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16343). |
| Pattern Value | true |
| 162. Observation.entryRelationship:severity.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 163. Observation.entryRelationship:severity.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 164. Observation.entryRelationship:severity.negationInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 165. Observation.entryRelationship:severity.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 166. Observation.entryRelationship:severity.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://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). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 167. Observation.entryRelationship:severity.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 168. Observation.entryRelationship:severity.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 169. Observation.entryRelationship:severity.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 170. Observation.entryRelationship:severity.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 171. Observation.entryRelationship:severity.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 172. Observation.entryRelationship:severity.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 173. Observation.entryRelationship:severity.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 174. Observation.entryRelationship:severity.act | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 175. Observation.entryRelationship:criticality | |
| SliceName | criticality |
| Control | 0..1 |
| Type | Element |
| Requirements | SHOULD contain zero or one [0..1] entryRelationship (CONF:1098-32910) such that it |
| Invariants | Defined 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) |
| 176. 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. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 177. 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, 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. |
| Invariants | Defined 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()) |
| Slicing | This element introduces a set of slices on Observation.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 178. Observation.entryRelationship:criticality.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In 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-32911). |
| Pattern Value | SUBJ |
| 179. Observation.entryRelationship:criticality.inversionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-32912). |
| Pattern Value | true |
| 180. Observation.entryRelationship:criticality.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 181. Observation.entryRelationship:criticality.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 182. Observation.entryRelationship:criticality.negationInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 183. Observation.entryRelationship:criticality.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 184. Observation.entryRelationship:criticality.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://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-32913). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 185. Observation.entryRelationship:criticality.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 186. Observation.entryRelationship:criticality.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 187. Observation.entryRelationship:criticality.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 188. Observation.entryRelationship:criticality.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 189. Observation.entryRelationship:criticality.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 190. Observation.entryRelationship:criticality.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 191. Observation.entryRelationship:criticality.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 192. Observation.entryRelationship:criticality.act | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 193. Observation.reference | |
| Control | 0..* |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 194. 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. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 195. 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, 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. |
| Invariants | Defined 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()) |
| Slicing | This element introduces a set of slices on Observation.reference.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 196. Observation.reference.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 197. Observation.reference.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 198. Observation.reference.externalAct | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalAct |
| 199. Observation.reference.externalObservation | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalObservation |
| 200. Observation.reference.externalProcedure | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure |
| 201. Observation.reference.externalDocument | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument |
| 202. Observation.precondition | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Precondition |
| 203. Observation.referenceRange | |
| Control | 0..* |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 204. 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. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 205. 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, 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. |
| Invariants | Defined 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()) |
| Slicing | This element introduces a set of slices on Observation.referenceRange.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 206. Observation.referenceRange.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActRelationshipPertains |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | REFV |
| Fixed Value | REFV |
| 207. Observation.referenceRange.observationRange | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationRange |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1.0-draft1 based on FHIR 5.0.0-snapshot3. Generated 2023-01-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change