Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/SubstanceOrDeviceAllergyIntoleranceObservation | Version: 4.0.0 | |||
Draft as of 2025-10-02 | Computable Name: SubstanceOrDeviceAllergyIntoleranceObservation | |||
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.24.3.90:2014-06-09 |
This template reflects a discrete observation about a patient's allergy or intolerance to a substance or device. Because it is a discrete observation, it will have a statusCode of "completed". The effectiveTime, also referred to as the 'clinically 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 Substance or Device Allergy - Intolerance Observation is the definitive indication of whether or not the underlying allergy/intolerance is resolved. If known to be resolved, then an effectiveTime/high would be present. If the date of resolution is not known, then effectiveTime/high will be present with a nullFlavor of "UNK".
Although open templates may contain any valid CDA content, the following templates are specifically called out by this template:
Optional EntryRelationships: AllergyStatusObservation, CriticalityObservation, ReactionObservation, SeverityObservation
Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 3.0.0:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 1..1 | Observation | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-author, should-not-severity |
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() |
1..1 | II | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.24.3.90 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | Required Pattern: 2014-06-09 | |
![]() ![]() ![]() |
1..1 | cs | Fixed Value: OBS | |
![]() ![]() ![]() |
1..1 | cs | Fixed Value: EVN | |
![]() ![]() ![]() |
1..* | II | ||
![]() ![]() ![]() |
1..1 | CD | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Required Pattern: ASSERTION | |
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.5.4 | |
![]() ![]() ![]() |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
![]() ![]() ![]() ![]() |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
![]() ![]() ![]() |
1..1 | CS | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: completed | |
![]() ![]() ![]() |
1..1 | IVL_TS | The effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became clinically active. The effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became clinically resolved. If the allergy/intolerance is known to be resolved, but the date of resolution is not known, then the high element SHALL be present, and the nullFlavor attribute SHALL be set to 'UNK'. | |
![]() ![]() ![]() ![]() |
1..1 | IVXB_TS | ||
![]() ![]() ![]() ![]() |
0..1 | IVXB_TS | ||
![]() ![]() ![]() |
1..1 | CD | ||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | cs | Binding: Allergy and Intolerance Type ![]() | |
![]() ![]() ![]() |
0..* | AuthorParticipation | ||
![]() ![]() ![]() |
0..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
![]() ![]() ![]() ![]() |
0..* | Participant2 | participant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: CSM | |
![]() ![]() ![]() ![]() ![]() |
1..1 | ParticipantRole | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: MANU | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | PlayingEntity | ||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: MMAT | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CE | Binding: Substance Reactant for Intolerance ![]() | |
![]() ![]() ![]() |
0..* | EntryRelationship | Slice: Unordered, Open by profile:observation | |
![]() ![]() ![]() ![]() |
0..1 | EntryRelationship | entryRelationship | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: SUBJ | |
![]() ![]() ![]() ![]() ![]() |
1..1 | bl | Fixed Value: true | |
![]() ![]() ![]() ![]() ![]() |
1..1 | AllergyStatusObservation | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | entryRelationship | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: MFST | |
![]() ![]() ![]() ![]() ![]() |
1..1 | bl | Fixed Value: true | |
![]() ![]() ![]() ![]() ![]() |
1..1 | ReactionObservation | ||
![]() ![]() ![]() ![]() |
0..1 | EntryRelationship | entryRelationship | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: SUBJ | |
![]() ![]() ![]() ![]() ![]() |
1..1 | bl | Fixed Value: true | |
![]() ![]() ![]() ![]() ![]() |
1..1 | SeverityObservation | ||
![]() ![]() ![]() ![]() |
0..1 | EntryRelationship | entryRelationship | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: SUBJ | |
![]() ![]() ![]() ![]() ![]() |
1..1 | bl | Fixed Value: true | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CriticalityObservation | ||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
Observation.value.code | Base | required |
Allergy and Intolerance Type
![]() |
📦20240606 | VSAC v0.23 |
Observation.participant:consumable.​participantRole.playingEntity.​code | Base | preferred |
Substance Reactant for Intolerance
![]() |
📦20240606 | VSAC v0.23 |
Id | Grade | Path(s) | Description | Expression |
should-author | warning | Observation | SHOULD contain author |
author.exists()
|
should-not-severity | warning | Observation | Allergy SHOULD NOT include severity. Severity belongs at reaction level, while Criticality is used at the allergy level. |
entryRelationship.observation.where(code.code = 'SEV' and code.codeSystem = '2.16.840.1.113883.5.4').empty()
|
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
Path | Status | Usage | ValueSet | Version | Source |
Observation.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.templateId:substance-device-allergy-intolerance-obs.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.classCode | Base | required | CDAActClassObservation | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.moodCode | Base | required | x_ActMoodDocumentObservation | 📍2.0.0 | THO v5.2 |
Observation.code | Base | example | ObservationType | 📦3.0.0 | THO v6.5 |
Observation.code.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
Observation.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
Observation.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
Observation.statusCode.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.effectiveTime.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.effectiveTime.​operator | Base | required | CDASetOperator | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
Observation.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
Observation.value.code | Base | required |
Allergy and Intolerance Type
![]() |
📦20240606 | VSAC v0.23 |
Observation.interpretationCode | Base | required | CDAObservationInterpretation | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.methodCode | Base | example | ObservationMethod | 📦3.0.0 | THO v6.5 |
Observation.participant:consumable.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.playingEntity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.playingEntity.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.playingEntity.​classCode | Base | required | EntityClassRoot | 📦3.0.0 | THO v6.5 |
Observation.participant:consumable.​participantRole.playingEntity.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
Observation.participant:consumable.​participantRole.playingEntity.​code | Base | preferred |
Substance Reactant for Intolerance
![]() |
📦20240606 | VSAC v0.23 |
Observation.entryRelationship:status.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:status.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:status.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Observation.entryRelationship:reaction.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:reaction.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:reaction.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Observation.entryRelationship:severity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:severity.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:severity.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Observation.entryRelationship:criticality.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:criticality.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:criticality.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Observation.referenceRange.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.referenceRange.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.referenceRange.​typeCode | Base | required | CDAActRelationshipType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Id | Grade | Path(s) | Description | Expression |
II-1 | error | Observation.typeId, Observation.participant:consumable.typeId, Observation.participant:consumable.participantRole.typeId, Observation.participant:consumable.participantRole.playingEntity.typeId, Observation.entryRelationship:status.typeId, Observation.entryRelationship:reaction.typeId, Observation.entryRelationship:severity.typeId, Observation.entryRelationship:criticality.typeId, Observation.referenceRange.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
should-author | warning | Observation | SHOULD contain author |
author.exists()
|
should-not-severity | warning | Observation | Allergy SHOULD NOT include severity. Severity belongs at reaction level, while Criticality is used at the allergy level. |
entryRelationship.observation.where(code.code = 'SEV' and code.codeSystem = '2.16.840.1.113883.5.4').empty()
|
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
Path | Status | Usage | ValueSet | Version | Source |
Observation.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.templateId:substance-device-allergy-intolerance-obs.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.classCode | Base | required | CDAActClassObservation | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.moodCode | Base | required | x_ActMoodDocumentObservation | 📍2.0.0 | THO v5.2 |
Observation.code | Base | example | ObservationType | 📦3.0.0 | THO v6.5 |
Observation.code.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
Observation.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
Observation.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
Observation.statusCode.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.effectiveTime.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.effectiveTime.​operator | Base | required | CDASetOperator | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
Observation.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
Observation.value.code | Base | required |
Allergy and Intolerance Type
![]() |
📦20240606 | VSAC v0.23 |
Observation.interpretationCode | Base | required | CDAObservationInterpretation | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.methodCode | Base | example | ObservationMethod | 📦3.0.0 | THO v6.5 |
Observation.participant:consumable.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.playingEntity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.playingEntity.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.playingEntity.​classCode | Base | required | EntityClassRoot | 📦3.0.0 | THO v6.5 |
Observation.participant:consumable.​participantRole.playingEntity.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
Observation.participant:consumable.​participantRole.playingEntity.​code | Base | preferred |
Substance Reactant for Intolerance
![]() |
📦20240606 | VSAC v0.23 |
Observation.entryRelationship:status.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:status.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:status.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Observation.entryRelationship:reaction.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:reaction.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:reaction.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Observation.entryRelationship:severity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:severity.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:severity.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Observation.entryRelationship:criticality.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:criticality.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:criticality.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Observation.referenceRange.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.referenceRange.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.referenceRange.​typeCode | Base | required | CDAActRelationshipType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Id | Grade | Path(s) | Description | Expression |
II-1 | error | Observation.typeId, Observation.participant:consumable.typeId, Observation.participant:consumable.participantRole.typeId, Observation.participant:consumable.participantRole.playingEntity.typeId, Observation.entryRelationship:status.typeId, Observation.entryRelationship:reaction.typeId, Observation.entryRelationship:severity.typeId, Observation.entryRelationship:criticality.typeId, Observation.referenceRange.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
should-author | warning | Observation | SHOULD contain author |
author.exists()
|
should-not-severity | warning | Observation | Allergy SHOULD NOT include severity. Severity belongs at reaction level, while Criticality is used at the allergy level. |
entryRelationship.observation.where(code.code = 'SEV' and code.codeSystem = '2.16.840.1.113883.5.4').empty()
|
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
This structure is derived from Observation
Summary
Mandatory: 13 elements(12 nested mandatory elements)
Fixed: 14 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 1..1 | Observation | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-author, should-not-severity |
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() |
1..1 | II | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.24.3.90 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | Required Pattern: 2014-06-09 | |
![]() ![]() ![]() |
1..1 | cs | Fixed Value: OBS | |
![]() ![]() ![]() |
1..1 | cs | Fixed Value: EVN | |
![]() ![]() ![]() |
1..* | II | ||
![]() ![]() ![]() |
1..1 | CD | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Required Pattern: ASSERTION | |
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.5.4 | |
![]() ![]() ![]() |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
![]() ![]() ![]() ![]() |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
![]() ![]() ![]() |
1..1 | CS | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: completed | |
![]() ![]() ![]() |
1..1 | IVL_TS | The effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became clinically active. The effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became clinically resolved. If the allergy/intolerance is known to be resolved, but the date of resolution is not known, then the high element SHALL be present, and the nullFlavor attribute SHALL be set to 'UNK'. | |
![]() ![]() ![]() ![]() |
1..1 | IVXB_TS | ||
![]() ![]() ![]() ![]() |
0..1 | IVXB_TS | ||
![]() ![]() ![]() |
1..1 | CD | ||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | cs | Binding: Allergy and Intolerance Type ![]() | |
![]() ![]() ![]() |
0..* | AuthorParticipation | ||
![]() ![]() ![]() |
0..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
![]() ![]() ![]() ![]() |
0..* | Participant2 | participant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: CSM | |
![]() ![]() ![]() ![]() ![]() |
1..1 | ParticipantRole | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: MANU | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | PlayingEntity | ||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: MMAT | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CE | Binding: Substance Reactant for Intolerance ![]() | |
![]() ![]() ![]() |
0..* | EntryRelationship | Slice: Unordered, Open by profile:observation | |
![]() ![]() ![]() ![]() |
0..1 | EntryRelationship | entryRelationship | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: SUBJ | |
![]() ![]() ![]() ![]() ![]() |
1..1 | bl | Fixed Value: true | |
![]() ![]() ![]() ![]() ![]() |
1..1 | AllergyStatusObservation | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | entryRelationship | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: MFST | |
![]() ![]() ![]() ![]() ![]() |
1..1 | bl | Fixed Value: true | |
![]() ![]() ![]() ![]() ![]() |
1..1 | ReactionObservation | ||
![]() ![]() ![]() ![]() |
0..1 | EntryRelationship | entryRelationship | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: SUBJ | |
![]() ![]() ![]() ![]() ![]() |
1..1 | bl | Fixed Value: true | |
![]() ![]() ![]() ![]() ![]() |
1..1 | SeverityObservation | ||
![]() ![]() ![]() ![]() |
0..1 | EntryRelationship | entryRelationship | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: SUBJ | |
![]() ![]() ![]() ![]() ![]() |
1..1 | bl | Fixed Value: true | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CriticalityObservation | ||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
Observation.value.code | Base | required |
Allergy and Intolerance Type
![]() |
📦20240606 | VSAC v0.23 |
Observation.participant:consumable.​participantRole.playingEntity.​code | Base | preferred |
Substance Reactant for Intolerance
![]() |
📦20240606 | VSAC v0.23 |
Id | Grade | Path(s) | Description | Expression |
should-author | warning | Observation | SHOULD contain author |
author.exists()
|
should-not-severity | warning | Observation | Allergy SHOULD NOT include severity. Severity belongs at reaction level, while Criticality is used at the allergy level. |
entryRelationship.observation.where(code.code = 'SEV' and code.codeSystem = '2.16.840.1.113883.5.4').empty()
|
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
Key Elements View
Path | Status | Usage | ValueSet | Version | Source |
Observation.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.templateId:substance-device-allergy-intolerance-obs.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.classCode | Base | required | CDAActClassObservation | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.moodCode | Base | required | x_ActMoodDocumentObservation | 📍2.0.0 | THO v5.2 |
Observation.code | Base | example | ObservationType | 📦3.0.0 | THO v6.5 |
Observation.code.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
Observation.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
Observation.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
Observation.statusCode.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.effectiveTime.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.effectiveTime.​operator | Base | required | CDASetOperator | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
Observation.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
Observation.value.code | Base | required |
Allergy and Intolerance Type
![]() |
📦20240606 | VSAC v0.23 |
Observation.interpretationCode | Base | required | CDAObservationInterpretation | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.methodCode | Base | example | ObservationMethod | 📦3.0.0 | THO v6.5 |
Observation.participant:consumable.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.playingEntity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.playingEntity.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.playingEntity.​classCode | Base | required | EntityClassRoot | 📦3.0.0 | THO v6.5 |
Observation.participant:consumable.​participantRole.playingEntity.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
Observation.participant:consumable.​participantRole.playingEntity.​code | Base | preferred |
Substance Reactant for Intolerance
![]() |
📦20240606 | VSAC v0.23 |
Observation.entryRelationship:status.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:status.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:status.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Observation.entryRelationship:reaction.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:reaction.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:reaction.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Observation.entryRelationship:severity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:severity.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:severity.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Observation.entryRelationship:criticality.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:criticality.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:criticality.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Observation.referenceRange.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.referenceRange.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.referenceRange.​typeCode | Base | required | CDAActRelationshipType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Id | Grade | Path(s) | Description | Expression |
II-1 | error | Observation.typeId, Observation.participant:consumable.typeId, Observation.participant:consumable.participantRole.typeId, Observation.participant:consumable.participantRole.playingEntity.typeId, Observation.entryRelationship:status.typeId, Observation.entryRelationship:reaction.typeId, Observation.entryRelationship:severity.typeId, Observation.entryRelationship:criticality.typeId, Observation.referenceRange.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
should-author | warning | Observation | SHOULD contain author |
author.exists()
|
should-not-severity | warning | Observation | Allergy SHOULD NOT include severity. Severity belongs at reaction level, while Criticality is used at the allergy level. |
entryRelationship.observation.where(code.code = 'SEV' and code.codeSystem = '2.16.840.1.113883.5.4').empty()
|
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
Snapshot View
Path | Status | Usage | ValueSet | Version | Source |
Observation.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.templateId:substance-device-allergy-intolerance-obs.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.classCode | Base | required | CDAActClassObservation | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.moodCode | Base | required | x_ActMoodDocumentObservation | 📍2.0.0 | THO v5.2 |
Observation.code | Base | example | ObservationType | 📦3.0.0 | THO v6.5 |
Observation.code.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
Observation.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
Observation.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
Observation.statusCode.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.effectiveTime.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.effectiveTime.​operator | Base | required | CDASetOperator | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
Observation.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
Observation.value.code | Base | required |
Allergy and Intolerance Type
![]() |
📦20240606 | VSAC v0.23 |
Observation.interpretationCode | Base | required | CDAObservationInterpretation | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.methodCode | Base | example | ObservationMethod | 📦3.0.0 | THO v6.5 |
Observation.participant:consumable.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.playingEntity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.playingEntity.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.participant:consumable.​participantRole.playingEntity.​classCode | Base | required | EntityClassRoot | 📦3.0.0 | THO v6.5 |
Observation.participant:consumable.​participantRole.playingEntity.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
Observation.participant:consumable.​participantRole.playingEntity.​code | Base | preferred |
Substance Reactant for Intolerance
![]() |
📦20240606 | VSAC v0.23 |
Observation.entryRelationship:status.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:status.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:status.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Observation.entryRelationship:reaction.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:reaction.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:reaction.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Observation.entryRelationship:severity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:severity.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:severity.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Observation.entryRelationship:criticality.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:criticality.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.entryRelationship:criticality.​typeCode | Base | required | x_ActRelationshipEntryRelationship | 📦3.0.0 | THO v6.5 |
Observation.referenceRange.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.referenceRange.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Observation.referenceRange.​typeCode | Base | required | CDAActRelationshipType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
Id | Grade | Path(s) | Description | Expression |
II-1 | error | Observation.typeId, Observation.participant:consumable.typeId, Observation.participant:consumable.participantRole.typeId, Observation.participant:consumable.participantRole.playingEntity.typeId, Observation.entryRelationship:status.typeId, Observation.entryRelationship:reaction.typeId, Observation.entryRelationship:severity.typeId, Observation.entryRelationship:criticality.typeId, Observation.referenceRange.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
should-author | warning | Observation | SHOULD contain author |
author.exists()
|
should-not-severity | warning | Observation | Allergy SHOULD NOT include severity. Severity belongs at reaction level, while Criticality is used at the allergy level. |
entryRelationship.observation.where(code.code = 'SEV' and code.codeSystem = '2.16.840.1.113883.5.4').empty()
|
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
This structure is derived from Observation
Summary
Mandatory: 13 elements(12 nested mandatory elements)
Fixed: 14 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices: