International Patient Summary (IPS), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 1.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-IPS/ and changes regularly. See the Directory of published versions
Draft as of 2024-08-04 |
Definitions for the 2.16.840.1.113883.10.22.4.1--20240804094850 logical model.
Guidance on how to interpret the contents of this table can be found here
0. Observation | |
Control | 0..* |
Must Support | true |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. Observation.templateId | |
Control | 1..? |
Slicing | This element introduces a set of slices on Observation.templateId . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
4. Observation.templateId:primary | |
Slice Name | primary |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Must Support | true |
6. Observation.templateId:primary.root | |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | 2.16.840.1.113883.10.22.4.1 |
8. Observation.classCode | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | OBS |
10. Observation.moodCode | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | EVN |
12. Observation.id | |
Control | 0..* |
Must Support | true |
14. Observation.code | |
Definition | This element describes whether this condition refers to an allergy, non-allergy intolerance, or unknown class of intolerance (not known to be allergy or intolerance). |
Control | 1..1 |
Binding | The codes SHALL be taken from Allergy or Intolerance Type (required to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.2--20161206000000 )Allergy or Intolerance Type |
Must Support | true |
16. Observation.text | |
Definition | The text element if present points to the text describing the problem being recorded; including any dates, comments, et cetera. The contains a URI in value attribute. This URI points to the free text description of the problem in the document that is being described. |
Control | 0..1 |
Must Support | true |
18. Observation.text.reference | |
Control | 1..1 |
Must Support | true |
20. Observation.text.reference.value | |
Definition | When used it shall refer to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1 |
Control | 1..1 |
Type | url |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
22. Observation.statusCode | |
Definition | A clinical document normally records only those condition observation events that have been completed, not observations that are in any other state. Therefore, the shall always have code='completed'. |
Control | 1..1 |
Must Support | true |
24. Observation.statusCode.code | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | completed |
26. Observation.effectiveTime | |
Definition | The effectiveTime, also referred to as the "biologically relevant time" is the time at which the observation holds for the patient. For a provider seeing a patient in the clinic today, observing a history of penicillin allergy that developed five years ago, the effectiveTime is five years ago. The effectiveTime of the Allergy - Intolerance Observation may give an indication of whether or not the underlying allergy/intolerance is resolved. The <low> and <high> values should be no more precise than known, but as precise as possible. |
Control | 1..1 |
Must Support | true |
28. Observation.effectiveTime.low | |
Definition | The effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active. |
Control | 1..1 |
Must Support | true |
30. Observation.effectiveTime.high | |
Definition | The effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved. If the date of resolution is not known, then effectiveTime/high will be present with a nullFlavor of "UNK".If this condition is known to be resolved, then the effectiveTime/high would be present. |
Control | 0..1 |
32. Observation.value | |
Control | 0..1 |
Binding | The codes SHOULD be taken from IPS Allergy or Intolerance Conditions (preferred to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.10--20240802091633 )IPS Allergy or Intolerance Conditions |
34. Observation.participant | |
Definition | The substance that causes the allergy or intolerance should be specified in the <participant> structure. This is the preferred way an allergy is supposed to be expressed. However it is recognized that in some contexts a controlled vocabulary is used for describing the allergy to a substance; or for asserting known absence or unavailability of information. In this case the <participant> structure shall be omitted. The agent responsible for an allergy or adverse reaction is not always a manufactured material (for example, food allergies), nor is it necessarily consumed. The following constraints reflect limitations in the base CDA R2 specification, and should be used to represent any type of responsible agent, i.e., use playingEntity classCode = "MMAT" for all agents, manufactured or not.IF the observation/value element is present and valued with a code derived form the 2.16.840.1.113883.11.22.9 Absent or Unknown Allergies value set THEN the observation/participant element used to describe the agent SHALL be omitted. |
Control | 0..1 |
36. Observation.participant.typeCode | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CSM |
38. Observation.participant.participantRole | |
Control | 1..1 |
Must Support | true |
40. Observation.participant.participantRole.classCode | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | MANU |
42. Observation.participant.participantRole.playingEntity | |
Control | 1..1 |
Must Support | true |
44. Observation.participant.participantRole.playingEntity.classCode | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | MMAT |
46. Observation.participant.participantRole.playingEntity.code | |
Definition | Code for the substance causing the allergy or intolerance. |
Control | 1..1 |
Binding | The codes SHOULD be taken from IPS Allergy or Intolerance Substances (preferred to http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-substance-condition-uv-ips )IPS Allergy or Intolerance Substances |
Must Support | true |
48. Observation.entryRelationship | |
Control | 1..? |
Slicing | This element introduces a set of slices on Observation.entryRelationship . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
50. Observation.entryRelationship:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Definition | The contained entry describes the reactions that are manifestations (typeCode='MFST') of the reported allergy or intolerance. |
Control | 0..* |
Must Support | true |
Invariants | entryRelationship-1: contains IPS Reaction Manifestation 2.16.840.1.113883.10.22.4.6 (2024-08-04) () |
52. Observation.entryRelationship:entryRelationship-1.typeCode | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | MFST |
54. Observation.entryRelationship:entryRelationship-1.inversionInd | |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | true |
56. Observation.entryRelationship:entryRelationship-1.observation:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(IPS Reaction Manifestation) |
Must Support | true |
58. Observation.entryRelationship:entryRelationship-2 | |
Slice Name | entryRelationship-2 |
Definition | Criticality |
Control | 1..1 |
Must Support | true |
Invariants | entryRelationship-2: contains IPS Criticality Observation 2.16.840.1.113883.10.22.4.18 (2017-03-27) () |
60. Observation.entryRelationship:entryRelationship-2.typeCode | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | SUBJ |
62. Observation.entryRelationship:entryRelationship-2.inversionInd | |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | true |
64. Observation.entryRelationship:entryRelationship-3 | |
Slice Name | entryRelationship-3 |
Definition | Certainty or Verification Status |
Control | 1..1 |
Must Support | true |
Invariants | entryRelationship-3: contains IPS Allergy Certainty Observation 2.16.840.1.113883.10.22.10 (2018-02-07) () |
66. Observation.entryRelationship:entryRelationship-3.typeCode | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | SUBJ |
68. Observation.entryRelationship:entryRelationship-3.inversionInd | |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | true |
70. Observation.entryRelationship:entryRelationship-4 | |
Slice Name | entryRelationship-4 |
Definition | **Status of the Allergy or Intolerance ** |
Control | 1..1 |
Must Support | true |
Invariants | entryRelationship-4: contains IPS Allergy Status Observation 2.16.840.1.113883.10.22.4.21 (2017-05-24) () |
72. Observation.entryRelationship:entryRelationship-4.typeCode | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | REFR |
74. Observation.entryRelationship:entryRelationship-4.inversionInd | |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | false |
Guidance on how to interpret the contents of this table can be found here
0. Observation | |
Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. |
Short | Base for all types and resources |
Control | 0..* |
Is Modifier | false |
Must Support | true |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. Observation.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Slicing | This element introduces a set of slices on Observation.templateId . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
4. Observation.templateId:primary | |
Slice Name | primary |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Must Support | true |
6. Observation.templateId:primary.root | |
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.10.22.4.1 |
8. Observation.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from CDAActClassObservation (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | OBS |
10. Observation.moodCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from XActMoodDocumentObservation (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | EVN |
12. Observation.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Short | Logical id of this artifact |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Control | 0..*1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IIstring |
Is Modifier | false |
Must Support | true |
14. Observation.code | |
Definition | This element describes whether this condition refers to an allergy, non-allergy intolerance, or unknown class of intolerance (not known to be allergy or intolerance). Describes what was observed. Sometimes this is called the observation "name". |
Short | Type of observation (code / type) |
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. |
Control | 1..1 |
Binding | The codes SHALL be taken from For example codes, see Allergy or Intolerance Typehttp://hl7.org/fhir/ValueSet/observation-codes (required to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.2--20161206000000 )Allergy or Intolerance Type Codes identifying names of simple observations. |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CDCodeableConcept |
Is Modifier | false |
Must Support | true |
XML Format | The type of this property is determined using the xsi:type attribute. |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Alternate Names | Name |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
16. Observation.text | |
Definition | The text element if present points to the text describing the problem being recorded; including any dates, comments, et cetera. The contains a URI in value attribute. This URI points to the free text description of the problem in the document that is being described. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Short | Text summary of the resource, for human interpretation |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EDNarrative |
Is Modifier | false |
Must Support | true |
XML Format | The type of this property is determined using the xsi:type attribute. |
Alternate Names | narrative, html, xhtml, display |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. Observation.text.reference | |
Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
Must Support | true |
Label | Reference |
20. Observation.text.reference.value | |
Definition | When used it shall refer to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1 |
Control | 1..1 |
Type | url |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
22. Observation.statusCode | |
Definition | A clinical document normally records only those condition observation events that have been completed, not observations that are in any other state. Therefore, the shall always have code='completed'. |
Control | 1..1 |
Binding | The codes SHALL be taken from ActStatus (required to http://terminology.hl7.org/ValueSet/v3-ActStatus ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
Must Support | true |
24. 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 | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code |
Fixed Value | completed |
26. Observation.statusCode.codeSystem | |
Definition | Specifies the code system that defines the code. |
Control | 0..0 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code System |
28. Observation.statusCode.codeSystemName | |
Definition | The common name of the coding system. |
Control | 0..0 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code System Name |
30. Observation.statusCode.codeSystemVersion | |
Definition | If applicable, a version descriptor defined specifically for the given code system. |
Control | 0..0 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code System Version |
32. Observation.statusCode.displayName | |
Definition | A name or title for the code, under which the sending system shows the code value to its users. |
Control | 0..0 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Display Name |
34. Observation.statusCode.originalText | |
Definition | The text or phrase used as the basis for the coding. |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
Label | Original Text |
36. Observation.statusCode.qualifier | |
Definition | Specifies additional codes that increase the specificity of the the primary code. |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
Label | Qualifier |
38. Observation.statusCode.translation | |
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Translation |
40. Observation.effectiveTime | |
Definition | The effectiveTime, also referred to as the "biologically relevant time" is the time at which the observation holds for the patient. For a provider seeing a patient in the clinic today, observing a history of penicillin allergy that developed five years ago, the effectiveTime is five years ago. The effectiveTime of the Allergy - Intolerance Observation may give an indication of whether or not the underlying allergy/intolerance is resolved. The <low> and <high> values should be no more precise than known, but as precise as possible. |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
Must Support | true |
42. Observation.effectiveTime.low | |
Definition | The effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active. |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
Must Support | true |
Label | Low Boundary |
44. Observation.effectiveTime.high | |
Definition | The effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved. If the date of resolution is not known, then effectiveTime/high will be present with a nullFlavor of "UNK".If this condition is known to be resolved, then the effectiveTime/high would be present. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
Label | High Boundary |
46. Observation.value | |
Control | 0..1 |
Binding | The codes SHOULD be taken from IPS Allergy or Intolerance Conditions (preferred to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.10--20240802091633 )IPS Allergy or Intolerance Conditions |
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/ANY, http://hl7.org/cda/stds/core/StructureDefinition/BL, http://hl7.org/cda/stds/core/StructureDefinition/ED, http://hl7.org/cda/stds/core/StructureDefinition/ST, http://hl7.org/cda/stds/core/StructureDefinition/CD, http://hl7.org/cda/stds/core/StructureDefinition/CV, http://hl7.org/cda/stds/core/StructureDefinition/CE, http://hl7.org/cda/stds/core/StructureDefinition/CO, http://hl7.org/cda/stds/core/StructureDefinition/SC, http://hl7.org/cda/stds/core/StructureDefinition/II, http://hl7.org/cda/stds/core/StructureDefinition/TEL, http://hl7.org/cda/stds/core/StructureDefinition/AD, http://hl7.org/cda/stds/core/StructureDefinition/EN, http://hl7.org/cda/stds/core/StructureDefinition/INT, http://hl7.org/cda/stds/core/StructureDefinition/REAL, http://hl7.org/cda/stds/core/StructureDefinition/PQ, http://hl7.org/cda/stds/core/StructureDefinition/MO, http://hl7.org/cda/stds/core/StructureDefinition/TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS, http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ |
XML Format | The type of this property is determined using the xsi:type attribute. |
48. Observation.participant | |
Definition | The substance that causes the allergy or intolerance should be specified in the <participant> structure. This is the preferred way an allergy is supposed to be expressed. However it is recognized that in some contexts a controlled vocabulary is used for describing the allergy to a substance; or for asserting known absence or unavailability of information. In this case the <participant> structure shall be omitted. The agent responsible for an allergy or adverse reaction is not always a manufactured material (for example, food allergies), nor is it necessarily consumed. The following constraints reflect limitations in the base CDA R2 specification, and should be used to represent any type of responsible agent, i.e., use playingEntity classCode = "MMAT" for all agents, manufactured or not.IF the observation/value element is present and valued with a code derived form the 2.16.840.1.113883.11.22.9 Absent or Unknown Allergies value set THEN the observation/participant element used to describe the agent SHALL be omitted. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
50. Observation.participant.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from CDAParticipationType (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CSM |
52. Observation.participant.participantRole | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole |
Must Support | true |
54. Observation.participant.participantRole.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from CDARoleClassRoot (required to http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | ROL |
Fixed Value | MANU |
56. Observation.participant.participantRole.playingEntity | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity |
Must Support | true |
58. Observation.participant.participantRole.playingEntity.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from EntityClassRoot (required to http://terminology.hl7.org/ValueSet/v3-EntityClassRoot ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | ENT |
Fixed Value | MMAT |
60. Observation.participant.participantRole.playingEntity.code | |
Definition | Code for the substance causing the allergy or intolerance. |
Control | 1..1 |
Binding | The codes SHOULD be taken from IPS Allergy or Intolerance Substances (preferred to http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-substance-condition-uv-ips )IPS Allergy or Intolerance Substances |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
Must Support | true |
62. Observation.entryRelationship | |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Slicing | This element introduces a set of slices on Observation.entryRelationship . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
64. Observation.entryRelationship:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Definition | The contained entry describes the reactions that are manifestations (typeCode='MFST') of the reported allergy or intolerance. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Must Support | true |
Invariants | entryRelationship-1: contains IPS Reaction Manifestation 2.16.840.1.113883.10.22.4.6 (2024-08-04) () |
66. Observation.entryRelationship:entryRelationship-1.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | MFST |
68. Observation.entryRelationship:entryRelationship-1.inversionInd | |
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed. |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | true |
70. Observation.entryRelationship:entryRelationship-1.observation:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. |
Short | Base for all types and resources |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(IPS Reaction Manifestation) |
Is Modifier | false |
Must Support | true |
72. Observation.entryRelationship:entryRelationship-2 | |
Slice Name | entryRelationship-2 |
Definition | Criticality |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Must Support | true |
Invariants | entryRelationship-2: contains IPS Criticality Observation 2.16.840.1.113883.10.22.4.18 (2017-03-27) () |
74. Observation.entryRelationship:entryRelationship-2.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | SUBJ |
76. Observation.entryRelationship:entryRelationship-2.inversionInd | |
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed. |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | true |
78. Observation.entryRelationship:entryRelationship-3 | |
Slice Name | entryRelationship-3 |
Definition | Certainty or Verification Status |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Must Support | true |
Invariants | entryRelationship-3: contains IPS Allergy Certainty Observation 2.16.840.1.113883.10.22.10 (2018-02-07) () |
80. Observation.entryRelationship:entryRelationship-3.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | SUBJ |
82. Observation.entryRelationship:entryRelationship-3.inversionInd | |
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed. |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | true |
84. Observation.entryRelationship:entryRelationship-4 | |
Slice Name | entryRelationship-4 |
Definition | **Status of the Allergy or Intolerance ** |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Must Support | true |
Invariants | entryRelationship-4: contains IPS Allergy Status Observation 2.16.840.1.113883.10.22.4.21 (2017-05-24) () |
86. Observation.entryRelationship:entryRelationship-4.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | REFR |
88. Observation.entryRelationship:entryRelationship-4.inversionInd | |
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed. |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | false |
Guidance on how to interpret the contents of this table can be found here
0. Observation | |
Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. |
Short | Base for all types and resources |
Control | 0..* |
Is Modifier | false |
Must Support | true |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. Observation.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
4. Observation.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
6. Observation.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
8. Observation.typeId.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
10. Observation.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
12. Observation.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
14. Observation.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
16. Observation.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
18. Observation.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Slicing | This element introduces a set of slices on Observation.templateId . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
20. Observation.templateId:primary | |
Slice Name | primary |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Must Support | true |
22. 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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
24. Observation.templateId:primary.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
26. Observation.templateId:primary.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
28. 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 |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.10.22.4.1 |
30. Observation.templateId:primary.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
32. Observation.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from CDAActClassObservation (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | OBS |
34. Observation.moodCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from XActMoodDocumentObservation (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | EVN |
36. Observation.negationInd | |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
38. Observation.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Must Support | true |
40. Observation.code | |
Definition | This element describes whether this condition refers to an allergy, non-allergy intolerance, or unknown class of intolerance (not known to be allergy or intolerance). |
Control | 1..1 |
Binding | The codes SHALL be taken from Allergy or Intolerance Type (required to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.2--20161206000000 )Allergy or Intolerance Type |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
Must Support | true |
XML Format | The type of this property is determined using the xsi:type attribute. |
42. Observation.derivationExpr | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ST |
44. Observation.text | |
Definition | The text element if present points to the text describing the problem being recorded; including any dates, comments, et cetera. The contains a URI in value attribute. This URI points to the free text description of the problem in the document that is being described. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
Must Support | true |
XML Format | The type of this property is determined using the xsi:type attribute. |
46. Observation.text.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
48. Observation.text.compression | |
Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDACompressionAlgorithm (required to http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Compression |
50. Observation.text.integrityCheck | |
Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created. |
Control | 0..1 |
Type | base64Binary(bin: Binary Data) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Integrity Check |
52. Observation.text.integrityCheckAlgorithm | |
Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage. |
Control | 0..1 |
Binding | The codes SHALL be taken from IntegrityCheckAlgorithm (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Integrity Check Algorithm |
54. Observation.text.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
56. Observation.text.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Binding | For example codes, see MediaType (example to http://terminology.hl7.org/ValueSet/v3-MediaType ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
58. Observation.text.representation | |
Control | 0..1 |
Binding | The codes SHALL be taken from CDABinaryDataEncoding (required to http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
60. Observation.text.xmlText | |
Definition | Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.) |
Short | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
62. Observation.text.reference | |
Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data. |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
Must Support | true |
Label | Reference |
64. Observation.text.reference.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
66. Observation.text.reference.value | |
Definition | When used it shall refer to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1 |
Control | 1..1 |
Type | url |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
68. Observation.text.reference.useablePeriod | |
Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address. |
Control | 0..* |
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Useable Period |
70. Observation.text.reference.use | |
Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
Control | 0..* |
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0 ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Use Code |
72. Observation.text.thumbnail | |
Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
Label | Thumbnail |
74. Observation.statusCode | |
Definition | A clinical document normally records only those condition observation events that have been completed, not observations that are in any other state. Therefore, the shall always have code='completed'. |
Control | 1..1 |
Binding | The codes SHALL be taken from ActStatus (required to http://terminology.hl7.org/ValueSet/v3-ActStatus ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
Must Support | true |
76. 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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
78. 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 | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code |
Fixed Value | completed |
80. Observation.statusCode.codeSystem | |
Definition | Specifies the code system that defines the code. |
Control | 0..0 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code System |
82. Observation.statusCode.codeSystemName | |
Definition | The common name of the coding system. |
Control | 0..0 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code System Name |
84. Observation.statusCode.codeSystemVersion | |
Definition | If applicable, a version descriptor defined specifically for the given code system. |
Control | 0..0 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code System Version |
86. Observation.statusCode.displayName | |
Definition | A name or title for the code, under which the sending system shows the code value to its users. |
Control | 0..0 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Display Name |
88. Observation.statusCode.sdtcValueSet | |
Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
Control | 0..1 |
Type | string(oid: ISO Object Identifier) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual namevalueSet . |
90. Observation.statusCode.sdtcValueSetVersion | |
Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual namevalueSetVersion . |
92. Observation.statusCode.originalText | |
Definition | The text or phrase used as the basis for the coding. |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
Label | Original Text |
94. Observation.statusCode.qualifier | |
Definition | Specifies additional codes that increase the specificity of the the primary code. |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
Label | Qualifier |
96. Observation.statusCode.translation | |
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Translation |
98. Observation.effectiveTime | |
Definition | The effectiveTime, also referred to as the "biologically relevant time" is the time at which the observation holds for the patient. For a provider seeing a patient in the clinic today, observing a history of penicillin allergy that developed five years ago, the effectiveTime is five years ago. The effectiveTime of the Allergy - Intolerance Observation may give an indication of whether or not the underlying allergy/intolerance is resolved. The <low> and <high> values should be no more precise than known, but as precise as possible. |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
Must Support | true |
100. 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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
102. 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(ts: Point in Time) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
XML Format | In the XML format, this property is represented as an attribute. |
104. Observation.effectiveTime.operator | |
Definition | A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDASetOperator (required to http://hl7.org/cda/stds/core/ValueSet/CDASetOperator ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | I |
106. Observation.effectiveTime.low | |
Definition | The effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active. |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
Must Support | true |
Label | Low Boundary |
108. Observation.effectiveTime.center | |
Definition | The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
Label | Central Value |
110. Observation.effectiveTime.width | |
Definition | The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
Label | Width |
112. Observation.effectiveTime.high | |
Definition | The effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved. If the date of resolution is not known, then effectiveTime/high will be present with a nullFlavor of "UNK".If this condition is known to be resolved, then the effectiveTime/high would be present. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
Label | High Boundary |
114. Observation.priorityCode | |
Control | 0..1 |
Binding | For example codes, see ActPriority (example to http://terminology.hl7.org/ValueSet/v3-ActPriority ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
116. Observation.repeatNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT |
118. Observation.languageCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
120. Observation.value | |
Control | 0..1 |
Binding | The codes SHOULD be taken from IPS Allergy or Intolerance Conditions (preferred to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.10--20240802091633 )IPS Allergy or Intolerance Conditions |
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/ANY, http://hl7.org/cda/stds/core/StructureDefinition/BL, http://hl7.org/cda/stds/core/StructureDefinition/ED, http://hl7.org/cda/stds/core/StructureDefinition/ST, http://hl7.org/cda/stds/core/StructureDefinition/CD, http://hl7.org/cda/stds/core/StructureDefinition/CV, http://hl7.org/cda/stds/core/StructureDefinition/CE, http://hl7.org/cda/stds/core/StructureDefinition/CO, http://hl7.org/cda/stds/core/StructureDefinition/SC, http://hl7.org/cda/stds/core/StructureDefinition/II, http://hl7.org/cda/stds/core/StructureDefinition/TEL, http://hl7.org/cda/stds/core/StructureDefinition/AD, http://hl7.org/cda/stds/core/StructureDefinition/EN, http://hl7.org/cda/stds/core/StructureDefinition/INT, http://hl7.org/cda/stds/core/StructureDefinition/REAL, http://hl7.org/cda/stds/core/StructureDefinition/PQ, http://hl7.org/cda/stds/core/StructureDefinition/MO, http://hl7.org/cda/stds/core/StructureDefinition/TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS, http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ |
XML Format | The type of this property is determined using the xsi:type attribute. |
122. Observation.interpretationCode | |
Control | 0..* |
Binding | The codes SHALL be taken from CDAObservationInterpretation (required to http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
124. Observation.methodCode | |
Control | 0..* |
Binding | For example codes, see ObservationMethod (example to http://terminology.hl7.org/ValueSet/v3-ObservationMethod ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
126. Observation.targetSiteCode | |
Definition | Drawn from concept domain ActSite |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
128. Observation.subject | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
130. Observation.specimen | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
132. Observation.performer | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
134. Observation.author | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
136. Observation.informant | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
138. Observation.participant | |
Definition | The substance that causes the allergy or intolerance should be specified in the <participant> structure. This is the preferred way an allergy is supposed to be expressed. However it is recognized that in some contexts a controlled vocabulary is used for describing the allergy to a substance; or for asserting known absence or unavailability of information. In this case the <participant> structure shall be omitted. The agent responsible for an allergy or adverse reaction is not always a manufactured material (for example, food allergies), nor is it necessarily consumed. The following constraints reflect limitations in the base CDA R2 specification, and should be used to represent any type of responsible agent, i.e., use playingEntity classCode = "MMAT" for all agents, manufactured or not.IF the observation/value element is present and valued with a code derived form the 2.16.840.1.113883.11.22.9 Absent or Unknown Allergies value set THEN the observation/participant element used to describe the agent SHALL be omitted. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
140. Observation.participant.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
142. Observation.participant.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
144. Observation.participant.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
146. Observation.participant.typeId.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
148. Observation.participant.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
150. Observation.participant.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
152. Observation.participant.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
154. Observation.participant.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
156. Observation.participant.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
158. Observation.participant.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from CDAParticipationType (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CSM |
160. Observation.participant.contextControlCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from CDAContextControl (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | OP |
162. Observation.participant.sdtcFunctionCode | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual namefunctionCode . |
164. Observation.participant.time | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
166. Observation.participant.awarenessCode | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
168. Observation.participant.participantRole | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole |
Must Support | true |
170. Observation.participant.participantRole.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
172. Observation.participant.participantRole.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
174. Observation.participant.participantRole.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
176. Observation.participant.participantRole.typeId.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
178. Observation.participant.participantRole.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
180. Observation.participant.participantRole.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
182. Observation.participant.participantRole.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
184. Observation.participant.participantRole.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
186. Observation.participant.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/cda/stds/core/StructureDefinition/II |
188. Observation.participant.participantRole.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from CDARoleClassRoot (required to http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | ROL |
Fixed Value | MANU |
190. Observation.participant.participantRole.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
192. Observation.participant.participantRole.sdtcIdentifiedBy | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual nameidentifiedBy . |
194. Observation.participant.participantRole.code | |
Control | 0..1 |
Binding | For example codes, see CDARoleCode (example to http://hl7.org/cda/stds/core/ValueSet/CDARoleCode ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
196. Observation.participant.participantRole.addr | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
198. Observation.participant.participantRole.telecom | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
200. Observation.participant.participantRole.playingDevice | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Device |
202. Observation.participant.participantRole.playingEntity | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity |
Must Support | true |
204. Observation.participant.participantRole.playingEntity.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
206. Observation.participant.participantRole.playingEntity.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
208. Observation.participant.participantRole.playingEntity.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
210. Observation.participant.participantRole.playingEntity.typeId.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
212. Observation.participant.participantRole.playingEntity.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
214. Observation.participant.participantRole.playingEntity.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
216. Observation.participant.participantRole.playingEntity.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
218. Observation.participant.participantRole.playingEntity.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
220. Observation.participant.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/cda/stds/core/StructureDefinition/II |
222. Observation.participant.participantRole.playingEntity.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from EntityClassRoot (required to http://terminology.hl7.org/ValueSet/v3-EntityClassRoot ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | ENT |
Fixed Value | MMAT |
224. Observation.participant.participantRole.playingEntity.determinerCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityDeterminer (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | INSTANCE |
226. Observation.participant.participantRole.playingEntity.code | |
Definition | Code for the substance causing the allergy or intolerance. |
Control | 1..1 |
Binding | The codes SHOULD be taken from IPS Allergy or Intolerance Substances (preferred to http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-substance-condition-uv-ips )IPS Allergy or Intolerance Substances |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
Must Support | true |
228. Observation.participant.participantRole.playingEntity.quantity | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
230. Observation.participant.participantRole.playingEntity.name | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN |
232. Observation.participant.participantRole.playingEntity.sdtcBirthTime | |
Definition | The purpose of this extension is to allow the recording of the subscriber or member of a health plan in cases where the health plan eligibility system has different information on file than the provider does for the patient. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual namebirthTime . |
234. Observation.participant.participantRole.playingEntity.desc | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
236. Observation.participant.participantRole.scopingEntity | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Entity |
238. Observation.entryRelationship | |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Slicing | This element introduces a set of slices on Observation.entryRelationship . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
240. Observation.entryRelationship:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Definition | The contained entry describes the reactions that are manifestations (typeCode='MFST') of the reported allergy or intolerance. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Must Support | true |
Invariants | entryRelationship-1: contains IPS Reaction Manifestation 2.16.840.1.113883.10.22.4.6 (2024-08-04) () |
242. Observation.entryRelationship:entryRelationship-1.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
244. Observation.entryRelationship:entryRelationship-1.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
246. Observation.entryRelationship:entryRelationship-1.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
248. Observation.entryRelationship:entryRelationship-1.typeId.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
250. Observation.entryRelationship:entryRelationship-1.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
252. Observation.entryRelationship:entryRelationship-1.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
254. Observation.entryRelationship:entryRelationship-1.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
256. Observation.entryRelationship:entryRelationship-1.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
258. Observation.entryRelationship:entryRelationship-1.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
260. Observation.entryRelationship:entryRelationship-1.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | MFST |
262. Observation.entryRelationship:entryRelationship-1.inversionInd | |
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed. |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | true |
264. Observation.entryRelationship:entryRelationship-1.contextConductionInd | |
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context. |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | true |
266. Observation.entryRelationship:entryRelationship-1.negationInd | |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
268. Observation.entryRelationship:entryRelationship-1.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
270. Observation.entryRelationship:entryRelationship-1.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
272. Observation.entryRelationship:entryRelationship-1.act | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
274. Observation.entryRelationship:entryRelationship-1.encounter | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
276. Observation.entryRelationship:entryRelationship-1.observation:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. |
Short | Base for all types and resources |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(IPS Reaction Manifestation) |
Is Modifier | false |
Must Support | true |
278. Observation.entryRelationship:entryRelationship-1.observationMedia | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
280. Observation.entryRelationship:entryRelationship-1.organizer | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
282. Observation.entryRelationship:entryRelationship-1.procedure | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
284. Observation.entryRelationship:entryRelationship-1.regionOfInterest | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
286. Observation.entryRelationship:entryRelationship-1.substanceAdministration | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
288. Observation.entryRelationship:entryRelationship-1.supply | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
290. Observation.entryRelationship:entryRelationship-2 | |
Slice Name | entryRelationship-2 |
Definition | Criticality |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Must Support | true |
Invariants | entryRelationship-2: contains IPS Criticality Observation 2.16.840.1.113883.10.22.4.18 (2017-03-27) () |
292. Observation.entryRelationship:entryRelationship-2.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
294. Observation.entryRelationship:entryRelationship-2.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
296. Observation.entryRelationship:entryRelationship-2.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
298. Observation.entryRelationship:entryRelationship-2.typeId.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
300. Observation.entryRelationship:entryRelationship-2.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
302. Observation.entryRelationship:entryRelationship-2.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
304. Observation.entryRelationship:entryRelationship-2.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
306. Observation.entryRelationship:entryRelationship-2.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
308. Observation.entryRelationship:entryRelationship-2.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
310. Observation.entryRelationship:entryRelationship-2.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | SUBJ |
312. Observation.entryRelationship:entryRelationship-2.inversionInd | |
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed. |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | true |
314. Observation.entryRelationship:entryRelationship-2.contextConductionInd | |
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context. |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | true |
316. Observation.entryRelationship:entryRelationship-2.negationInd | |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
318. Observation.entryRelationship:entryRelationship-2.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
320. Observation.entryRelationship:entryRelationship-2.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
322. Observation.entryRelationship:entryRelationship-2.act | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
324. Observation.entryRelationship:entryRelationship-2.encounter | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
326. Observation.entryRelationship:entryRelationship-2.observation | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation |
328. Observation.entryRelationship:entryRelationship-2.observationMedia | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
330. Observation.entryRelationship:entryRelationship-2.organizer | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
332. Observation.entryRelationship:entryRelationship-2.procedure | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
334. Observation.entryRelationship:entryRelationship-2.regionOfInterest | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
336. Observation.entryRelationship:entryRelationship-2.substanceAdministration | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
338. Observation.entryRelationship:entryRelationship-2.supply | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
340. Observation.entryRelationship:entryRelationship-3 | |
Slice Name | entryRelationship-3 |
Definition | Certainty or Verification Status |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Must Support | true |
Invariants | entryRelationship-3: contains IPS Allergy Certainty Observation 2.16.840.1.113883.10.22.10 (2018-02-07) () |
342. Observation.entryRelationship:entryRelationship-3.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
344. Observation.entryRelationship:entryRelationship-3.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
346. Observation.entryRelationship:entryRelationship-3.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
348. Observation.entryRelationship:entryRelationship-3.typeId.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
350. Observation.entryRelationship:entryRelationship-3.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
352. Observation.entryRelationship:entryRelationship-3.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
354. Observation.entryRelationship:entryRelationship-3.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
356. Observation.entryRelationship:entryRelationship-3.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
358. Observation.entryRelationship:entryRelationship-3.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
360. Observation.entryRelationship:entryRelationship-3.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | SUBJ |
362. Observation.entryRelationship:entryRelationship-3.inversionInd | |
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed. |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | true |
364. Observation.entryRelationship:entryRelationship-3.contextConductionInd | |
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context. |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | true |
366. Observation.entryRelationship:entryRelationship-3.negationInd | |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
368. Observation.entryRelationship:entryRelationship-3.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
370. Observation.entryRelationship:entryRelationship-3.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
372. Observation.entryRelationship:entryRelationship-3.act | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
374. Observation.entryRelationship:entryRelationship-3.encounter | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
376. Observation.entryRelationship:entryRelationship-3.observation | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation |
378. Observation.entryRelationship:entryRelationship-3.observationMedia | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
380. Observation.entryRelationship:entryRelationship-3.organizer | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
382. Observation.entryRelationship:entryRelationship-3.procedure | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
384. Observation.entryRelationship:entryRelationship-3.regionOfInterest | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
386. Observation.entryRelationship:entryRelationship-3.substanceAdministration | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
388. Observation.entryRelationship:entryRelationship-3.supply | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
390. Observation.entryRelationship:entryRelationship-4 | |
Slice Name | entryRelationship-4 |
Definition | **Status of the Allergy or Intolerance ** |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Must Support | true |
Invariants | entryRelationship-4: contains IPS Allergy Status Observation 2.16.840.1.113883.10.22.4.21 (2017-05-24) () |
392. Observation.entryRelationship:entryRelationship-4.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
394. Observation.entryRelationship:entryRelationship-4.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
396. Observation.entryRelationship:entryRelationship-4.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
398. Observation.entryRelationship:entryRelationship-4.typeId.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
400. Observation.entryRelationship:entryRelationship-4.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
402. Observation.entryRelationship:entryRelationship-4.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
404. Observation.entryRelationship:entryRelationship-4.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
406. Observation.entryRelationship:entryRelationship-4.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
408. Observation.entryRelationship:entryRelationship-4.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
410. Observation.entryRelationship:entryRelationship-4.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | REFR |
412. Observation.entryRelationship:entryRelationship-4.inversionInd | |
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed. |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | false |
414. Observation.entryRelationship:entryRelationship-4.contextConductionInd | |
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context. |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | true |
416. Observation.entryRelationship:entryRelationship-4.negationInd | |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
418. Observation.entryRelationship:entryRelationship-4.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
420. Observation.entryRelationship:entryRelationship-4.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
422. Observation.entryRelationship:entryRelationship-4.act | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
424. Observation.entryRelationship:entryRelationship-4.encounter | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
426. Observation.entryRelationship:entryRelationship-4.observation | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation |
428. Observation.entryRelationship:entryRelationship-4.observationMedia | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
430. Observation.entryRelationship:entryRelationship-4.organizer | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
432. Observation.entryRelationship:entryRelationship-4.procedure | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
434. Observation.entryRelationship:entryRelationship-4.regionOfInterest | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
436. Observation.entryRelationship:entryRelationship-4.substanceAdministration | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
438. Observation.entryRelationship:entryRelationship-4.supply | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
440. Observation.reference | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
442. Observation.precondition | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
444. Observation.sdtcPrecondition2 | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition2 |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual nameprecondition2 . |
446. Observation.referenceRange | |
Definition | Relates an Observation to the ObservationRange class, where the expected range of values for a particular observation can be specified. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
448. Observation.referenceRange.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
450. Observation.referenceRange.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
452. Observation.referenceRange.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
454. Observation.referenceRange.typeId.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
456. Observation.referenceRange.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
458. Observation.referenceRange.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
460. Observation.referenceRange.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
462. Observation.referenceRange.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
464. Observation.referenceRange.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
466. Observation.referenceRange.typeCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from CDAActRelationshipType (required to http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | REFV |
468. Observation.referenceRange.observationRange | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationRange |
470. Observation.sdtcInFulfillmentOf1 | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1 |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual nameinFulfillmentOf1 . |